forked from aws/aws-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 1
/
api.go
1557 lines (1297 loc) · 48.6 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 polly
import (
"io"
"time"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
)
const opDeleteLexicon = "DeleteLexicon"
// DeleteLexiconRequest generates a "aws/request.Request" representing the
// client's request for the DeleteLexicon operation. The "output" return
// value will be populated with the request's response once the request completes
// successfuly.
//
// 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 DeleteLexicon for more information on using the DeleteLexicon
// 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 DeleteLexiconRequest method.
// req, resp := client.DeleteLexiconRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/DeleteLexicon
func (c *Polly) DeleteLexiconRequest(input *DeleteLexiconInput) (req *request.Request, output *DeleteLexiconOutput) {
op := &request.Operation{
Name: opDeleteLexicon,
HTTPMethod: "DELETE",
HTTPPath: "/v1/lexicons/{LexiconName}",
}
if input == nil {
input = &DeleteLexiconInput{}
}
output = &DeleteLexiconOutput{}
req = c.newRequest(op, input, output)
return
}
// DeleteLexicon API operation for Amazon Polly.
//
// Deletes the specified pronunciation lexicon stored in an AWS Region. A lexicon
// which has been deleted is not available for speech synthesis, nor is it possible
// to retrieve it using either the GetLexicon or ListLexicon APIs.
//
// For more information, see Managing Lexicons (http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.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 Polly's
// API operation DeleteLexicon for usage and error information.
//
// Returned Error Codes:
// * ErrCodeLexiconNotFoundException "LexiconNotFoundException"
// Amazon Polly can't find the specified lexicon. This could be caused by a
// lexicon that is missing, its name is misspelled or specifying a lexicon that
// is in a different region.
//
// Verify that the lexicon exists, is in the region (see ListLexicons) and that
// you spelled its name is spelled correctly. Then try again.
//
// * ErrCodeServiceFailureException "ServiceFailureException"
// An unknown condition has caused a service failure.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/DeleteLexicon
func (c *Polly) DeleteLexicon(input *DeleteLexiconInput) (*DeleteLexiconOutput, error) {
req, out := c.DeleteLexiconRequest(input)
return out, req.Send()
}
// DeleteLexiconWithContext is the same as DeleteLexicon with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteLexicon 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 *Polly) DeleteLexiconWithContext(ctx aws.Context, input *DeleteLexiconInput, opts ...request.Option) (*DeleteLexiconOutput, error) {
req, out := c.DeleteLexiconRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeVoices = "DescribeVoices"
// DescribeVoicesRequest generates a "aws/request.Request" representing the
// client's request for the DescribeVoices operation. The "output" return
// value will be populated with the request's response once the request completes
// successfuly.
//
// 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 DescribeVoices for more information on using the DescribeVoices
// 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 DescribeVoicesRequest method.
// req, resp := client.DescribeVoicesRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/DescribeVoices
func (c *Polly) DescribeVoicesRequest(input *DescribeVoicesInput) (req *request.Request, output *DescribeVoicesOutput) {
op := &request.Operation{
Name: opDescribeVoices,
HTTPMethod: "GET",
HTTPPath: "/v1/voices",
}
if input == nil {
input = &DescribeVoicesInput{}
}
output = &DescribeVoicesOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeVoices API operation for Amazon Polly.
//
// Returns the list of voices that are available for use when requesting speech
// synthesis. Each voice speaks a specified language, is either male or female,
// and is identified by an ID, which is the ASCII version of the voice name.
//
// When synthesizing speech ( SynthesizeSpeech ), you provide the voice ID for
// the voice you want from the list of voices returned by DescribeVoices.
//
// For example, you want your news reader application to read news in a specific
// language, but giving a user the option to choose the voice. Using the DescribeVoices
// operation you can provide the user with a list of available voices to select
// from.
//
// You can optionally specify a language code to filter the available voices.
// For example, if you specify en-US, the operation returns a list of all available
// US English voices.
//
// This operation requires permissions to perform the polly:DescribeVoices action.
//
// 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 Polly's
// API operation DescribeVoices for usage and error information.
//
// Returned Error Codes:
// * ErrCodeInvalidNextTokenException "InvalidNextTokenException"
// The NextToken is invalid. Verify that it's spelled correctly, and then try
// again.
//
// * ErrCodeServiceFailureException "ServiceFailureException"
// An unknown condition has caused a service failure.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/DescribeVoices
func (c *Polly) DescribeVoices(input *DescribeVoicesInput) (*DescribeVoicesOutput, error) {
req, out := c.DescribeVoicesRequest(input)
return out, req.Send()
}
// DescribeVoicesWithContext is the same as DescribeVoices with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeVoices 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 *Polly) DescribeVoicesWithContext(ctx aws.Context, input *DescribeVoicesInput, opts ...request.Option) (*DescribeVoicesOutput, error) {
req, out := c.DescribeVoicesRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opGetLexicon = "GetLexicon"
// GetLexiconRequest generates a "aws/request.Request" representing the
// client's request for the GetLexicon operation. The "output" return
// value will be populated with the request's response once the request completes
// successfuly.
//
// 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 GetLexicon for more information on using the GetLexicon
// 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 GetLexiconRequest method.
// req, resp := client.GetLexiconRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/GetLexicon
func (c *Polly) GetLexiconRequest(input *GetLexiconInput) (req *request.Request, output *GetLexiconOutput) {
op := &request.Operation{
Name: opGetLexicon,
HTTPMethod: "GET",
HTTPPath: "/v1/lexicons/{LexiconName}",
}
if input == nil {
input = &GetLexiconInput{}
}
output = &GetLexiconOutput{}
req = c.newRequest(op, input, output)
return
}
// GetLexicon API operation for Amazon Polly.
//
// Returns the content of the specified pronunciation lexicon stored in an AWS
// Region. For more information, see Managing Lexicons (http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.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 Polly's
// API operation GetLexicon for usage and error information.
//
// Returned Error Codes:
// * ErrCodeLexiconNotFoundException "LexiconNotFoundException"
// Amazon Polly can't find the specified lexicon. This could be caused by a
// lexicon that is missing, its name is misspelled or specifying a lexicon that
// is in a different region.
//
// Verify that the lexicon exists, is in the region (see ListLexicons) and that
// you spelled its name is spelled correctly. Then try again.
//
// * ErrCodeServiceFailureException "ServiceFailureException"
// An unknown condition has caused a service failure.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/GetLexicon
func (c *Polly) GetLexicon(input *GetLexiconInput) (*GetLexiconOutput, error) {
req, out := c.GetLexiconRequest(input)
return out, req.Send()
}
// GetLexiconWithContext is the same as GetLexicon with the addition of
// the ability to pass a context and additional request options.
//
// See GetLexicon 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 *Polly) GetLexiconWithContext(ctx aws.Context, input *GetLexiconInput, opts ...request.Option) (*GetLexiconOutput, error) {
req, out := c.GetLexiconRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opListLexicons = "ListLexicons"
// ListLexiconsRequest generates a "aws/request.Request" representing the
// client's request for the ListLexicons operation. The "output" return
// value will be populated with the request's response once the request completes
// successfuly.
//
// 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 ListLexicons for more information on using the ListLexicons
// 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 ListLexiconsRequest method.
// req, resp := client.ListLexiconsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/ListLexicons
func (c *Polly) ListLexiconsRequest(input *ListLexiconsInput) (req *request.Request, output *ListLexiconsOutput) {
op := &request.Operation{
Name: opListLexicons,
HTTPMethod: "GET",
HTTPPath: "/v1/lexicons",
}
if input == nil {
input = &ListLexiconsInput{}
}
output = &ListLexiconsOutput{}
req = c.newRequest(op, input, output)
return
}
// ListLexicons API operation for Amazon Polly.
//
// Returns a list of pronunciation lexicons stored in an AWS Region. For more
// information, see Managing Lexicons (http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.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 Polly's
// API operation ListLexicons for usage and error information.
//
// Returned Error Codes:
// * ErrCodeInvalidNextTokenException "InvalidNextTokenException"
// The NextToken is invalid. Verify that it's spelled correctly, and then try
// again.
//
// * ErrCodeServiceFailureException "ServiceFailureException"
// An unknown condition has caused a service failure.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/ListLexicons
func (c *Polly) ListLexicons(input *ListLexiconsInput) (*ListLexiconsOutput, error) {
req, out := c.ListLexiconsRequest(input)
return out, req.Send()
}
// ListLexiconsWithContext is the same as ListLexicons with the addition of
// the ability to pass a context and additional request options.
//
// See ListLexicons 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 *Polly) ListLexiconsWithContext(ctx aws.Context, input *ListLexiconsInput, opts ...request.Option) (*ListLexiconsOutput, error) {
req, out := c.ListLexiconsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opPutLexicon = "PutLexicon"
// PutLexiconRequest generates a "aws/request.Request" representing the
// client's request for the PutLexicon operation. The "output" return
// value will be populated with the request's response once the request completes
// successfuly.
//
// 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 PutLexicon for more information on using the PutLexicon
// 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 PutLexiconRequest method.
// req, resp := client.PutLexiconRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/PutLexicon
func (c *Polly) PutLexiconRequest(input *PutLexiconInput) (req *request.Request, output *PutLexiconOutput) {
op := &request.Operation{
Name: opPutLexicon,
HTTPMethod: "PUT",
HTTPPath: "/v1/lexicons/{LexiconName}",
}
if input == nil {
input = &PutLexiconInput{}
}
output = &PutLexiconOutput{}
req = c.newRequest(op, input, output)
return
}
// PutLexicon API operation for Amazon Polly.
//
// Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same
// name already exists in the region, it is overwritten by the new lexicon.
// Lexicon operations have eventual consistency, therefore, it might take some
// time before the lexicon is available to the SynthesizeSpeech operation.
//
// For more information, see Managing Lexicons (http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.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 Polly's
// API operation PutLexicon for usage and error information.
//
// Returned Error Codes:
// * ErrCodeInvalidLexiconException "InvalidLexiconException"
// Amazon Polly can't find the specified lexicon. Verify that the lexicon's
// name is spelled correctly, and then try again.
//
// * ErrCodeUnsupportedPlsAlphabetException "UnsupportedPlsAlphabetException"
// The alphabet specified by the lexicon is not a supported alphabet. Valid
// values are x-sampa and ipa.
//
// * ErrCodeUnsupportedPlsLanguageException "UnsupportedPlsLanguageException"
// The language specified in the lexicon is unsupported. For a list of supported
// languages, see Lexicon Attributes (http://docs.aws.amazon.com/polly/latest/dg/API_LexiconAttributes.html).
//
// * ErrCodeLexiconSizeExceededException "LexiconSizeExceededException"
// The maximum size of the specified lexicon would be exceeded by this operation.
//
// * ErrCodeMaxLexemeLengthExceededException "MaxLexemeLengthExceededException"
// The maximum size of the lexeme would be exceeded by this operation.
//
// * ErrCodeMaxLexiconsNumberExceededException "MaxLexiconsNumberExceededException"
// The maximum number of lexicons would be exceeded by this operation.
//
// * ErrCodeServiceFailureException "ServiceFailureException"
// An unknown condition has caused a service failure.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/PutLexicon
func (c *Polly) PutLexicon(input *PutLexiconInput) (*PutLexiconOutput, error) {
req, out := c.PutLexiconRequest(input)
return out, req.Send()
}
// PutLexiconWithContext is the same as PutLexicon with the addition of
// the ability to pass a context and additional request options.
//
// See PutLexicon 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 *Polly) PutLexiconWithContext(ctx aws.Context, input *PutLexiconInput, opts ...request.Option) (*PutLexiconOutput, error) {
req, out := c.PutLexiconRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opSynthesizeSpeech = "SynthesizeSpeech"
// SynthesizeSpeechRequest generates a "aws/request.Request" representing the
// client's request for the SynthesizeSpeech operation. The "output" return
// value will be populated with the request's response once the request completes
// successfuly.
//
// 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 SynthesizeSpeech for more information on using the SynthesizeSpeech
// 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 SynthesizeSpeechRequest method.
// req, resp := client.SynthesizeSpeechRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/SynthesizeSpeech
func (c *Polly) SynthesizeSpeechRequest(input *SynthesizeSpeechInput) (req *request.Request, output *SynthesizeSpeechOutput) {
op := &request.Operation{
Name: opSynthesizeSpeech,
HTTPMethod: "POST",
HTTPPath: "/v1/speech",
}
if input == nil {
input = &SynthesizeSpeechInput{}
}
output = &SynthesizeSpeechOutput{}
req = c.newRequest(op, input, output)
return
}
// SynthesizeSpeech API operation for Amazon Polly.
//
// Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input
// must be valid, well-formed SSML. Some alphabets might not be available with
// all the voices (for example, Cyrillic might not be read at all by English
// voices) unless phoneme mapping is used. For more information, see How it
// Works (http://docs.aws.amazon.com/polly/latest/dg/how-text-to-speech-works.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 Polly's
// API operation SynthesizeSpeech for usage and error information.
//
// Returned Error Codes:
// * ErrCodeTextLengthExceededException "TextLengthExceededException"
// The value of the "Text" parameter is longer than the accepted limits. The
// limit for input text is a maximum of 3000 characters total, of which no more
// than 1500 can be billed characters. SSML tags are not counted as billed characters.
//
// * ErrCodeInvalidSampleRateException "InvalidSampleRateException"
// The specified sample rate is not valid.
//
// * ErrCodeInvalidSsmlException "InvalidSsmlException"
// The SSML you provided is invalid. Verify the SSML syntax, spelling of tags
// and values, and then try again.
//
// * ErrCodeLexiconNotFoundException "LexiconNotFoundException"
// Amazon Polly can't find the specified lexicon. This could be caused by a
// lexicon that is missing, its name is misspelled or specifying a lexicon that
// is in a different region.
//
// Verify that the lexicon exists, is in the region (see ListLexicons) and that
// you spelled its name is spelled correctly. Then try again.
//
// * ErrCodeServiceFailureException "ServiceFailureException"
// An unknown condition has caused a service failure.
//
// * ErrCodeMarksNotSupportedForFormatException "MarksNotSupportedForFormatException"
// Speech marks are not supported for the OutputFormat selected. Speech marks
// are only available for content in json format.
//
// * ErrCodeSsmlMarksNotSupportedForTextTypeException "SsmlMarksNotSupportedForTextTypeException"
// SSML speech marks are not supported for plain text-type input.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/SynthesizeSpeech
func (c *Polly) SynthesizeSpeech(input *SynthesizeSpeechInput) (*SynthesizeSpeechOutput, error) {
req, out := c.SynthesizeSpeechRequest(input)
return out, req.Send()
}
// SynthesizeSpeechWithContext is the same as SynthesizeSpeech with the addition of
// the ability to pass a context and additional request options.
//
// See SynthesizeSpeech 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 *Polly) SynthesizeSpeechWithContext(ctx aws.Context, input *SynthesizeSpeechInput, opts ...request.Option) (*SynthesizeSpeechOutput, error) {
req, out := c.SynthesizeSpeechRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
type DeleteLexiconInput struct {
_ struct{} `type:"structure"`
// The name of the lexicon to delete. Must be an existing lexicon in the region.
//
// Name is a required field
Name *string `location:"uri" locationName:"LexiconName" type:"string" required:"true"`
}
// String returns the string representation
func (s DeleteLexiconInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeleteLexiconInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteLexiconInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteLexiconInput"}
if s.Name == nil {
invalidParams.Add(request.NewErrParamRequired("Name"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetName sets the Name field's value.
func (s *DeleteLexiconInput) SetName(v string) *DeleteLexiconInput {
s.Name = &v
return s
}
type DeleteLexiconOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s DeleteLexiconOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeleteLexiconOutput) GoString() string {
return s.String()
}
type DescribeVoicesInput struct {
_ struct{} `type:"structure"`
// The language identification tag (ISO 639 code for the language name-ISO 3166
// country code) for filtering the list of voices returned. If you don't specify
// this optional parameter, all available voices are returned.
LanguageCode *string `location:"querystring" locationName:"LanguageCode" type:"string" enum:"LanguageCode"`
// An opaque pagination token returned from the previous DescribeVoices operation.
// If present, this indicates where to continue the listing.
NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
}
// String returns the string representation
func (s DescribeVoicesInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeVoicesInput) GoString() string {
return s.String()
}
// SetLanguageCode sets the LanguageCode field's value.
func (s *DescribeVoicesInput) SetLanguageCode(v string) *DescribeVoicesInput {
s.LanguageCode = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *DescribeVoicesInput) SetNextToken(v string) *DescribeVoicesInput {
s.NextToken = &v
return s
}
type DescribeVoicesOutput struct {
_ struct{} `type:"structure"`
// The pagination token to use in the next request to continue the listing of
// voices. NextToken is returned only if the response is truncated.
NextToken *string `type:"string"`
// A list of voices with their properties.
Voices []*Voice `type:"list"`
}
// String returns the string representation
func (s DescribeVoicesOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeVoicesOutput) GoString() string {
return s.String()
}
// SetNextToken sets the NextToken field's value.
func (s *DescribeVoicesOutput) SetNextToken(v string) *DescribeVoicesOutput {
s.NextToken = &v
return s
}
// SetVoices sets the Voices field's value.
func (s *DescribeVoicesOutput) SetVoices(v []*Voice) *DescribeVoicesOutput {
s.Voices = v
return s
}
type GetLexiconInput struct {
_ struct{} `type:"structure"`
// Name of the lexicon.
//
// Name is a required field
Name *string `location:"uri" locationName:"LexiconName" type:"string" required:"true"`
}
// String returns the string representation
func (s GetLexiconInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetLexiconInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetLexiconInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GetLexiconInput"}
if s.Name == nil {
invalidParams.Add(request.NewErrParamRequired("Name"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetName sets the Name field's value.
func (s *GetLexiconInput) SetName(v string) *GetLexiconInput {
s.Name = &v
return s
}
type GetLexiconOutput struct {
_ struct{} `type:"structure"`
// Lexicon object that provides name and the string content of the lexicon.
Lexicon *Lexicon `type:"structure"`
// Metadata of the lexicon, including phonetic alphabetic used, language code,
// lexicon ARN, number of lexemes defined in the lexicon, and size of lexicon
// in bytes.
LexiconAttributes *LexiconAttributes `type:"structure"`
}
// String returns the string representation
func (s GetLexiconOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetLexiconOutput) GoString() string {
return s.String()
}
// SetLexicon sets the Lexicon field's value.
func (s *GetLexiconOutput) SetLexicon(v *Lexicon) *GetLexiconOutput {
s.Lexicon = v
return s
}
// SetLexiconAttributes sets the LexiconAttributes field's value.
func (s *GetLexiconOutput) SetLexiconAttributes(v *LexiconAttributes) *GetLexiconOutput {
s.LexiconAttributes = v
return s
}
// Provides lexicon name and lexicon content in string format. For more information,
// see Pronunciation Lexicon Specification (PLS) Version 1.0 (https://www.w3.org/TR/pronunciation-lexicon/).
type Lexicon struct {
_ struct{} `type:"structure"`
// Lexicon content in string format. The content of a lexicon must be in PLS
// format.
Content *string `type:"string"`
// Name of the lexicon.
Name *string `type:"string"`
}
// String returns the string representation
func (s Lexicon) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s Lexicon) GoString() string {
return s.String()
}
// SetContent sets the Content field's value.
func (s *Lexicon) SetContent(v string) *Lexicon {
s.Content = &v
return s
}
// SetName sets the Name field's value.
func (s *Lexicon) SetName(v string) *Lexicon {
s.Name = &v
return s
}
// Contains metadata describing the lexicon such as the number of lexemes, language
// code, and so on. For more information, see Managing Lexicons (http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html).
type LexiconAttributes struct {
_ struct{} `type:"structure"`
// Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.
Alphabet *string `type:"string"`
// Language code that the lexicon applies to. A lexicon with a language code
// such as "en" would be applied to all English languages (en-GB, en-US, en-AUS,
// en-WLS, and so on.
LanguageCode *string `type:"string" enum:"LanguageCode"`
// Date lexicon was last modified (a timestamp value).
LastModified *time.Time `type:"timestamp" timestampFormat:"unix"`
// Number of lexemes in the lexicon.
LexemesCount *int64 `type:"integer"`
// Amazon Resource Name (ARN) of the lexicon.
LexiconArn *string `type:"string"`
// Total size of the lexicon, in characters.
Size *int64 `type:"integer"`
}
// String returns the string representation
func (s LexiconAttributes) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s LexiconAttributes) GoString() string {
return s.String()
}
// SetAlphabet sets the Alphabet field's value.
func (s *LexiconAttributes) SetAlphabet(v string) *LexiconAttributes {
s.Alphabet = &v
return s
}
// SetLanguageCode sets the LanguageCode field's value.
func (s *LexiconAttributes) SetLanguageCode(v string) *LexiconAttributes {
s.LanguageCode = &v
return s
}
// SetLastModified sets the LastModified field's value.
func (s *LexiconAttributes) SetLastModified(v time.Time) *LexiconAttributes {
s.LastModified = &v
return s
}
// SetLexemesCount sets the LexemesCount field's value.
func (s *LexiconAttributes) SetLexemesCount(v int64) *LexiconAttributes {
s.LexemesCount = &v
return s
}
// SetLexiconArn sets the LexiconArn field's value.
func (s *LexiconAttributes) SetLexiconArn(v string) *LexiconAttributes {
s.LexiconArn = &v
return s
}
// SetSize sets the Size field's value.
func (s *LexiconAttributes) SetSize(v int64) *LexiconAttributes {
s.Size = &v
return s
}
// Describes the content of the lexicon.
type LexiconDescription struct {
_ struct{} `type:"structure"`
// Provides lexicon metadata.
Attributes *LexiconAttributes `type:"structure"`
// Name of the lexicon.
Name *string `type:"string"`
}
// String returns the string representation
func (s LexiconDescription) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s LexiconDescription) GoString() string {
return s.String()
}
// SetAttributes sets the Attributes field's value.
func (s *LexiconDescription) SetAttributes(v *LexiconAttributes) *LexiconDescription {
s.Attributes = v
return s
}
// SetName sets the Name field's value.
func (s *LexiconDescription) SetName(v string) *LexiconDescription {
s.Name = &v
return s
}
type ListLexiconsInput struct {
_ struct{} `type:"structure"`
// An opaque pagination token returned from previous ListLexicons operation.
// If present, indicates where to continue the list of lexicons.
NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
}
// String returns the string representation
func (s ListLexiconsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ListLexiconsInput) GoString() string {
return s.String()
}
// SetNextToken sets the NextToken field's value.
func (s *ListLexiconsInput) SetNextToken(v string) *ListLexiconsInput {
s.NextToken = &v
return s
}
type ListLexiconsOutput struct {
_ struct{} `type:"structure"`
// A list of lexicon names and attributes.
Lexicons []*LexiconDescription `type:"list"`
// The pagination token to use in the next request to continue the listing of
// lexicons. NextToken is returned only if the response is truncated.
NextToken *string `type:"string"`
}
// String returns the string representation
func (s ListLexiconsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ListLexiconsOutput) GoString() string {
return s.String()
}
// SetLexicons sets the Lexicons field's value.
func (s *ListLexiconsOutput) SetLexicons(v []*LexiconDescription) *ListLexiconsOutput {
s.Lexicons = v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListLexiconsOutput) SetNextToken(v string) *ListLexiconsOutput {
s.NextToken = &v
return s
}
type PutLexiconInput struct {
_ struct{} `type:"structure"`
// Content of the PLS lexicon as string data.
//
// Content is a required field
Content *string `type:"string" required:"true"`
// Name of the lexicon. The name must follow the regular express format [0-9A-Za-z]{1,20}.
// That is, the name is a case-sensitive alphanumeric string up to 20 characters
// long.
//
// Name is a required field
Name *string `location:"uri" locationName:"LexiconName" type:"string" required:"true"`
}
// String returns the string representation
func (s PutLexiconInput) String() string {
return awsutil.Prettify(s)
}