forked from cPu1/aws-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.go
1167 lines (1044 loc) · 44.7 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 lexruntimeservice
import (
"io"
"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/aws/signer/v4"
)
const opPostContent = "PostContent"
// PostContentRequest generates a "aws/request.Request" representing the
// client's request for the PostContent operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See PostContent for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the PostContent method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the PostContentRequest method.
// req, resp := client.PostContentRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostContent
func (c *LexRuntimeService) PostContentRequest(input *PostContentInput) (req *request.Request, output *PostContentOutput) {
op := &request.Operation{
Name: opPostContent,
HTTPMethod: "POST",
HTTPPath: "/bot/{botName}/alias/{botAlias}/user/{userId}/content",
}
if input == nil {
input = &PostContentInput{}
}
output = &PostContentOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Sign.Remove(v4.SignRequestHandler)
handler := v4.BuildNamedHandler("v4.CustomSignerHandler", v4.WithUnsignedPayload)
req.Handlers.Sign.PushFrontNamed(handler)
return
}
// PostContent API operation for Amazon Lex Runtime Service.
//
// Sends user input (text or speech) to Amazon Lex. Clients use this API to
// send requests to Amazon Lex at runtime. Amazon Lex interprets the user input
// using the machine learning model that it built for the bot.
//
// In response, Amazon Lex returns the next message to convey to the user. Consider
// the following example messages:
//
// * For a user input "I would like a pizza," Amazon Lex might return a
// response with a message eliciting slot data (for example, PizzaSize):
// "What size pizza would you like?".
//
// * After the user provides all of the pizza order information, Amazon
// Lex might return a response with a message to get user confirmation: "Order
// the pizza?".
//
// * After the user replies "Yes" to the confirmation prompt, Amazon Lex
// might return a conclusion statement: "Thank you, your cheese pizza has
// been ordered.".
//
// Not all Amazon Lex messages require a response from the user. For example,
// conclusion statements do not require a response. Some messages require only
// a yes or no response. In addition to the message, Amazon Lex provides additional
// context about the message in the response that you can use to enhance client
// behavior, such as displaying the appropriate client user interface. Consider
// the following examples:
//
// * If the message is to elicit slot data, Amazon Lex returns the following
// context information:
//
// x-amz-lex-dialog-state header set to ElicitSlot
//
// x-amz-lex-intent-name header set to the intent name in the current context
//
//
// x-amz-lex-slot-to-elicit header set to the slot name for which the message
// is eliciting information
//
// x-amz-lex-slots header set to a map of slots configured for the intent with
// their current values
//
// * If the message is a confirmation prompt, the x-amz-lex-dialog-state
// header is set to Confirmation and the x-amz-lex-slot-to-elicit header
// is omitted.
//
// * If the message is a clarification prompt configured for the intent,
// indicating that the user intent is not understood, the x-amz-dialog-state
// header is set to ElicitIntent and the x-amz-slot-to-elicit header is omitted.
//
//
// In addition, Amazon Lex also returns your application-specific sessionAttributes.
// For more information, see Managing Conversation Context (http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.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 Lex Runtime Service's
// API operation PostContent for usage and error information.
//
// Returned Error Codes:
// * ErrCodeNotFoundException "NotFoundException"
// The resource (such as the Amazon Lex bot or an alias) that is referred to
// is not found.
//
// * ErrCodeBadRequestException "BadRequestException"
// Request validation failed, there is no usable message in the context, or
// the bot build failed.
//
// * ErrCodeLimitExceededException "LimitExceededException"
// Exceeded a limit.
//
// * ErrCodeInternalFailureException "InternalFailureException"
// Internal service error. Retry the call.
//
// * ErrCodeConflictException "ConflictException"
// Two clients are using the same AWS account, Amazon Lex bot, and user ID.
//
// * ErrCodeUnsupportedMediaTypeException "UnsupportedMediaTypeException"
// The Content-Type header (PostContent API) has an invalid value.
//
// * ErrCodeNotAcceptableException "NotAcceptableException"
// The accept header in the request does not have a valid value.
//
// * ErrCodeRequestTimeoutException "RequestTimeoutException"
// The input speech is too long.
//
// * ErrCodeDependencyFailedException "DependencyFailedException"
// One of the downstream dependencies, such as AWS Lambda or Amazon Polly, threw
// an exception. For example, if Amazon Lex does not have sufficient permissions
// to call a Lambda function, it results in Lambda throwing an exception.
//
// * ErrCodeBadGatewayException "BadGatewayException"
// Either the Amazon Lex bot is still building, or one of the dependent services
// (Amazon Polly, AWS Lambda) failed with an internal service error.
//
// * ErrCodeLoopDetectedException "LoopDetectedException"
// Lambda fulfilment function returned DelegateDialogAction to Amazon Lex without
// changing any slot values.
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostContent
func (c *LexRuntimeService) PostContent(input *PostContentInput) (*PostContentOutput, error) {
req, out := c.PostContentRequest(input)
return out, req.Send()
}
// PostContentWithContext is the same as PostContent with the addition of
// the ability to pass a context and additional request options.
//
// See PostContent 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 *LexRuntimeService) PostContentWithContext(ctx aws.Context, input *PostContentInput, opts ...request.Option) (*PostContentOutput, error) {
req, out := c.PostContentRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opPostText = "PostText"
// PostTextRequest generates a "aws/request.Request" representing the
// client's request for the PostText operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See PostText for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the PostText method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the PostTextRequest method.
// req, resp := client.PostTextRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostText
func (c *LexRuntimeService) PostTextRequest(input *PostTextInput) (req *request.Request, output *PostTextOutput) {
op := &request.Operation{
Name: opPostText,
HTTPMethod: "POST",
HTTPPath: "/bot/{botName}/alias/{botAlias}/user/{userId}/text",
}
if input == nil {
input = &PostTextInput{}
}
output = &PostTextOutput{}
req = c.newRequest(op, input, output)
return
}
// PostText API operation for Amazon Lex Runtime Service.
//
// Sends user input (text-only) to Amazon Lex. Client applications can use this
// API to send requests to Amazon Lex at runtime. Amazon Lex then interprets
// the user input using the machine learning model it built for the bot.
//
// In response, Amazon Lex returns the next message to convey to the user an
// optional responseCard to display. Consider the following example messages:
//
// * For a user input "I would like a pizza", Amazon Lex might return a
// response with a message eliciting slot data (for example, PizzaSize):
// "What size pizza would you like?"
//
// * After the user provides all of the pizza order information, Amazon
// Lex might return a response with a message to obtain user confirmation
// "Proceed with the pizza order?".
//
// * After the user replies to a confirmation prompt with a "yes", Amazon
// Lex might return a conclusion statement: "Thank you, your cheese pizza
// has been ordered.".
//
// Not all Amazon Lex messages require a user response. For example, a conclusion
// statement does not require a response. Some messages require only a "yes"
// or "no" user response. In addition to the message, Amazon Lex provides additional
// context about the message in the response that you might use to enhance client
// behavior, for example, to display the appropriate client user interface.
// These are the slotToElicit, dialogState, intentName, and slots fields in
// the response. Consider the following examples:
//
// * If the message is to elicit slot data, Amazon Lex returns the following
// context information:
//
// dialogState set to ElicitSlot
//
// intentName set to the intent name in the current context
//
// slotToElicit set to the slot name for which the message is eliciting information
//
//
// slots set to a map of slots, configured for the intent, with currently known
// values
//
// * If the message is a confirmation prompt, the dialogState is set to
// ConfirmIntent and SlotToElicit is set to null.
//
// * If the message is a clarification prompt (configured for the intent)
// that indicates that user intent is not understood, the dialogState is
// set to ElicitIntent and slotToElicit is set to null.
//
// In addition, Amazon Lex also returns your application-specific sessionAttributes.
// For more information, see Managing Conversation Context (http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.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 Lex Runtime Service's
// API operation PostText for usage and error information.
//
// Returned Error Codes:
// * ErrCodeNotFoundException "NotFoundException"
// The resource (such as the Amazon Lex bot or an alias) that is referred to
// is not found.
//
// * ErrCodeBadRequestException "BadRequestException"
// Request validation failed, there is no usable message in the context, or
// the bot build failed.
//
// * ErrCodeLimitExceededException "LimitExceededException"
// Exceeded a limit.
//
// * ErrCodeInternalFailureException "InternalFailureException"
// Internal service error. Retry the call.
//
// * ErrCodeConflictException "ConflictException"
// Two clients are using the same AWS account, Amazon Lex bot, and user ID.
//
// * ErrCodeDependencyFailedException "DependencyFailedException"
// One of the downstream dependencies, such as AWS Lambda or Amazon Polly, threw
// an exception. For example, if Amazon Lex does not have sufficient permissions
// to call a Lambda function, it results in Lambda throwing an exception.
//
// * ErrCodeBadGatewayException "BadGatewayException"
// Either the Amazon Lex bot is still building, or one of the dependent services
// (Amazon Polly, AWS Lambda) failed with an internal service error.
//
// * ErrCodeLoopDetectedException "LoopDetectedException"
// Lambda fulfilment function returned DelegateDialogAction to Amazon Lex without
// changing any slot values.
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostText
func (c *LexRuntimeService) PostText(input *PostTextInput) (*PostTextOutput, error) {
req, out := c.PostTextRequest(input)
return out, req.Send()
}
// PostTextWithContext is the same as PostText with the addition of
// the ability to pass a context and additional request options.
//
// See PostText 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 *LexRuntimeService) PostTextWithContext(ctx aws.Context, input *PostTextInput, opts ...request.Option) (*PostTextOutput, error) {
req, out := c.PostTextRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// Represents an option to be shown on the client platform (Facebook, Slack,
// etc.)
// Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/Button
type Button struct {
_ struct{} `type:"structure"`
// Text that is visible to the user on the button.
//
// Text is a required field
Text *string `locationName:"text" min:"1" type:"string" required:"true"`
// The value sent to Amazon Lex when a user chooses the button. For example,
// consider button text "NYC." When the user chooses the button, the value sent
// can be "New York City."
//
// Value is a required field
Value *string `locationName:"value" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s Button) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s Button) GoString() string {
return s.String()
}
// SetText sets the Text field's value.
func (s *Button) SetText(v string) *Button {
s.Text = &v
return s
}
// SetValue sets the Value field's value.
func (s *Button) SetValue(v string) *Button {
s.Value = &v
return s
}
// Represents an option rendered to the user when a prompt is shown. It could
// be an image, a button, a link, or text.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/GenericAttachment
type GenericAttachment struct {
_ struct{} `type:"structure"`
// The URL of an attachment to the response card.
AttachmentLinkUrl *string `locationName:"attachmentLinkUrl" min:"1" type:"string"`
// The list of options to show to the user.
Buttons []*Button `locationName:"buttons" type:"list"`
// The URL of an image that is displayed to the user.
ImageUrl *string `locationName:"imageUrl" min:"1" type:"string"`
// The subtitle shown below the title.
SubTitle *string `locationName:"subTitle" min:"1" type:"string"`
// The title of the option.
Title *string `locationName:"title" min:"1" type:"string"`
}
// String returns the string representation
func (s GenericAttachment) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GenericAttachment) GoString() string {
return s.String()
}
// SetAttachmentLinkUrl sets the AttachmentLinkUrl field's value.
func (s *GenericAttachment) SetAttachmentLinkUrl(v string) *GenericAttachment {
s.AttachmentLinkUrl = &v
return s
}
// SetButtons sets the Buttons field's value.
func (s *GenericAttachment) SetButtons(v []*Button) *GenericAttachment {
s.Buttons = v
return s
}
// SetImageUrl sets the ImageUrl field's value.
func (s *GenericAttachment) SetImageUrl(v string) *GenericAttachment {
s.ImageUrl = &v
return s
}
// SetSubTitle sets the SubTitle field's value.
func (s *GenericAttachment) SetSubTitle(v string) *GenericAttachment {
s.SubTitle = &v
return s
}
// SetTitle sets the Title field's value.
func (s *GenericAttachment) SetTitle(v string) *GenericAttachment {
s.Title = &v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostContentRequest
type PostContentInput struct {
_ struct{} `type:"structure" payload:"InputStream"`
// You pass this value as the Accept HTTP header.
//
// The message Amazon Lex returns in the response can be either text or speech
// based on the Accept HTTP header value in the request.
//
// * If the value is text/plain; charset=utf-8, Amazon Lex returns text
// in the response.
//
// * If the value begins with audio/, Amazon Lex returns speech in the response.
// Amazon Lex uses Amazon Polly to generate the speech (using the configuration
// you specified in the Accept header). For example, if you specify audio/mpeg
// as the value, Amazon Lex returns speech in the MPEG format.
//
// The following are the accepted values:
//
// audio/mpeg
//
// audio/ogg
//
// audio/pcm
//
// text/plain; charset=utf-8
//
// audio/* (defaults to mpeg)
Accept *string `location:"header" locationName:"Accept" type:"string"`
// Alias of the Amazon Lex bot.
//
// BotAlias is a required field
BotAlias *string `location:"uri" locationName:"botAlias" type:"string" required:"true"`
// Name of the Amazon Lex bot.
//
// BotName is a required field
BotName *string `location:"uri" locationName:"botName" type:"string" required:"true"`
// You pass this values as the Content-Type HTTP header.
//
// Indicates the audio format or text. The header value must start with one
// of the following prefixes:
//
// * PCM format
//
// audio/l16; rate=16000; channels=1
//
// audio/x-l16; sample-rate=16000; channel-count=1
//
// * Opus format
//
// audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=1; frame-size-milliseconds=1.1
//
// * Text format
//
// text/plain; charset=utf-8
//
// ContentType is a required field
ContentType *string `location:"header" locationName:"Content-Type" type:"string" required:"true"`
// User input in PCM or Opus audio format or text format as described in the
// Content-Type HTTP header.
//
// InputStream is a required field
InputStream io.ReadSeeker `locationName:"inputStream" type:"blob" required:"true"`
// You pass this value in the x-amz-lex-session-attributes HTTP header. The
// value must be map (keys and values must be strings) that is JSON serialized
// and then base64 encoded.
//
// A session represents dialog between a user and Amazon Lex. At runtime, a
// client application can pass contextual information, in the request to Amazon
// Lex. For example,
//
// * You might use session attributes to track the requestID of user requests.
//
// * In Getting Started Exercise 1, the example bot uses the price session
// attribute to maintain the price of flowers ordered (for example, "price":25).
// The code hook (Lambda function) sets this attribute based on the type
// of flowers ordered. For more information, see Review the Details of Information
// Flow (http://docs.aws.amazon.com/lex/latest/dg/gs-bp-details-after-lambda.html).
//
//
// * In the BookTrip bot exercise, the bot uses the currentReservation session
// attribute to maintains the slot data during the in-progress conversation
// to book a hotel or book a car. For more information, see Details of Information
// Flow (http://docs.aws.amazon.com/lex/latest/dg/book-trip-detail-flow.html).
//
//
// Amazon Lex passes these session attributes to the Lambda functions configured
// for the intent In the your Lambda function, you can use the session attributes
// for initialization and customization (prompts). Some examples are:
//
// * Initialization - In a pizza ordering bot, if you pass user location
// (for example, "Location : 111 Maple Street"), then your Lambda function
// might use this information to determine the closest pizzeria to place
// the order (and perhaps set the storeAddress slot value as well).
//
// Personalized prompts - For example, you can configure prompts to refer to
// the user by name (for example, "Hey [firstName], what toppings would you
// like?"). You can pass the user's name as a session attribute ("firstName":
// "Joe") so that Amazon Lex can substitute the placeholder to provide a
// personalized prompt to the user ("Hey Joe, what toppings would you like?").
//
//
// Amazon Lex does not persist session attributes.
//
// If you configured a code hook for the intent, Amazon Lex passes the incoming
// session attributes to the Lambda function. The Lambda function must return
// these session attributes if you want Amazon Lex to return them to the client.
//
// If there is no code hook configured for the intent Amazon Lex simply returns
// the session attributes to the client application.
SessionAttributes aws.JSONValue `location:"header" locationName:"x-amz-lex-session-attributes" type:"jsonvalue"`
// ID of the client application user. Typically, each of your application users
// should have a unique ID. The application developer decides the user IDs.
// At runtime, each request must include the user ID. Note the following considerations:
//
// * If you want a user to start conversation on one device and continue
// the conversation on another device, you might choose a user-specific identifier,
// such as the user's login, or Amazon Cognito user ID (assuming your application
// is using Amazon Cognito).
//
// * If you want the same user to be able to have two independent conversations
// on two different devices, you might choose device-specific identifier,
// such as device ID, or some globally unique identifier.
//
// UserId is a required field
UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"`
}
// String returns the string representation
func (s PostContentInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s PostContentInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *PostContentInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "PostContentInput"}
if s.BotAlias == nil {
invalidParams.Add(request.NewErrParamRequired("BotAlias"))
}
if s.BotName == nil {
invalidParams.Add(request.NewErrParamRequired("BotName"))
}
if s.ContentType == nil {
invalidParams.Add(request.NewErrParamRequired("ContentType"))
}
if s.InputStream == nil {
invalidParams.Add(request.NewErrParamRequired("InputStream"))
}
if s.UserId == nil {
invalidParams.Add(request.NewErrParamRequired("UserId"))
}
if s.UserId != nil && len(*s.UserId) < 2 {
invalidParams.Add(request.NewErrParamMinLen("UserId", 2))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAccept sets the Accept field's value.
func (s *PostContentInput) SetAccept(v string) *PostContentInput {
s.Accept = &v
return s
}
// SetBotAlias sets the BotAlias field's value.
func (s *PostContentInput) SetBotAlias(v string) *PostContentInput {
s.BotAlias = &v
return s
}
// SetBotName sets the BotName field's value.
func (s *PostContentInput) SetBotName(v string) *PostContentInput {
s.BotName = &v
return s
}
// SetContentType sets the ContentType field's value.
func (s *PostContentInput) SetContentType(v string) *PostContentInput {
s.ContentType = &v
return s
}
// SetInputStream sets the InputStream field's value.
func (s *PostContentInput) SetInputStream(v io.ReadSeeker) *PostContentInput {
s.InputStream = v
return s
}
// SetSessionAttributes sets the SessionAttributes field's value.
func (s *PostContentInput) SetSessionAttributes(v aws.JSONValue) *PostContentInput {
s.SessionAttributes = v
return s
}
// SetUserId sets the UserId field's value.
func (s *PostContentInput) SetUserId(v string) *PostContentInput {
s.UserId = &v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostContentResponse
type PostContentOutput struct {
_ struct{} `type:"structure" payload:"AudioStream"`
// The prompt (or statement) to convey to the user. This is based on the bot
// configuration and context. For example, if Amazon Lex did not understand
// the user intent, it sends the clarificationPrompt configured for the bot.
// If the intent requires confirmation before taking the fulfillment action,
// it sends the confirmationPrompt. Another example: Suppose that the Lambda
// function successfully fulfilled the intent, and sent a message to convey
// to the user. Then Amazon Lex sends that message in the response.
AudioStream io.ReadCloser `locationName:"audioStream" type:"blob"`
// Content type as specified in the Accept HTTP header in the request.
ContentType *string `location:"header" locationName:"Content-Type" type:"string"`
// Identifies the current state of the user interaction. Amazon Lex returns
// one of the following values as dialogState. The client can optionally use
// this information to customize the user interface.
//
// * ElicitIntent – Amazon Lex wants to elicit the user's intent. Consider
// the following examples:
//
// For example, a user might utter an intent ("I want to order a pizza"). If
// Amazon Lex cannot infer the user intent from this utterance, it will return
// this dialog state.
//
// * ConfirmIntent – Amazon Lex is expecting a "yes" or "no" response.
//
// For example, Amazon Lex wants user confirmation before fulfilling an intent.
// Instead of a simple "yes" or "no" response, a user might respond with
// additional information. For example, "yes, but make it a thick crust pizza"
// or "no, I want to order a drink." Amazon Lex can process such additional
// information (in these examples, update the crust type slot or change the
// intent from OrderPizza to OrderDrink).
//
// * ElicitSlot – Amazon Lex is expecting the value of a slot for the current
// intent.
//
// For example, suppose that in the response Amazon Lex sends this message:
// "What size pizza would you like?". A user might reply with the slot value
// (e.g., "medium"). The user might also provide additional information in
// the response (e.g., "medium thick crust pizza"). Amazon Lex can process
// such additional information appropriately.
//
// * Fulfilled – Conveys that the Lambda function has successfully fulfilled
// the intent.
//
// * ReadyForFulfillment – Conveys that the client has to fullfill the request.
//
//
// * Failed – Conveys that the conversation with the user failed.
//
// This can happen for various reasons, including that the user does not provide
// an appropriate response to prompts from the service (you can configure
// how many times Amazon Lex can prompt a user for specific information),
// or if the Lambda function fails to fulfill the intent.
DialogState *string `location:"header" locationName:"x-amz-lex-dialog-state" type:"string" enum:"DialogState"`
// Transcript of the voice input to the operation.
InputTranscript *string `location:"header" locationName:"x-amz-lex-input-transcript" type:"string"`
// Current user intent that Amazon Lex is aware of.
IntentName *string `location:"header" locationName:"x-amz-lex-intent-name" type:"string"`
// Message to convey to the user. It can come from the bot's configuration or
// a code hook (Lambda function). If the current intent is not configured with
// a code hook or if the code hook returned Delegate as the dialogAction.type
// in its response, then Amazon Lex decides the next course of action and selects
// an appropriate message from the bot configuration based on the current user
// interaction context. For example, if Amazon Lex is not able to understand
// the user input, it uses a clarification prompt message (For more information,
// see the Error Handling section in the Amazon Lex console). Another example:
// if the intent requires confirmation before fulfillment, then Amazon Lex uses
// the confirmation prompt message in the intent configuration. If the code
// hook returns a message, Amazon Lex passes it as-is in its response to the
// client.
Message *string `location:"header" locationName:"x-amz-lex-message" min:"1" type:"string"`
// Map of key/value pairs representing the session-specific context information.
SessionAttributes aws.JSONValue `location:"header" locationName:"x-amz-lex-session-attributes" type:"jsonvalue"`
// If the dialogState value is ElicitSlot, returns the name of the slot for
// which Amazon Lex is eliciting a value.
SlotToElicit *string `location:"header" locationName:"x-amz-lex-slot-to-elicit" type:"string"`
// Map of zero or more intent slots (name/value pairs) Amazon Lex detected from
// the user input during the conversation.
Slots aws.JSONValue `location:"header" locationName:"x-amz-lex-slots" type:"jsonvalue"`
}
// String returns the string representation
func (s PostContentOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s PostContentOutput) GoString() string {
return s.String()
}
// SetAudioStream sets the AudioStream field's value.
func (s *PostContentOutput) SetAudioStream(v io.ReadCloser) *PostContentOutput {
s.AudioStream = v
return s
}
// SetContentType sets the ContentType field's value.
func (s *PostContentOutput) SetContentType(v string) *PostContentOutput {
s.ContentType = &v
return s
}
// SetDialogState sets the DialogState field's value.
func (s *PostContentOutput) SetDialogState(v string) *PostContentOutput {
s.DialogState = &v
return s
}
// SetInputTranscript sets the InputTranscript field's value.
func (s *PostContentOutput) SetInputTranscript(v string) *PostContentOutput {
s.InputTranscript = &v
return s
}
// SetIntentName sets the IntentName field's value.
func (s *PostContentOutput) SetIntentName(v string) *PostContentOutput {
s.IntentName = &v
return s
}
// SetMessage sets the Message field's value.
func (s *PostContentOutput) SetMessage(v string) *PostContentOutput {
s.Message = &v
return s
}
// SetSessionAttributes sets the SessionAttributes field's value.
func (s *PostContentOutput) SetSessionAttributes(v aws.JSONValue) *PostContentOutput {
s.SessionAttributes = v
return s
}
// SetSlotToElicit sets the SlotToElicit field's value.
func (s *PostContentOutput) SetSlotToElicit(v string) *PostContentOutput {
s.SlotToElicit = &v
return s
}
// SetSlots sets the Slots field's value.
func (s *PostContentOutput) SetSlots(v aws.JSONValue) *PostContentOutput {
s.Slots = v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostTextRequest
type PostTextInput struct {
_ struct{} `type:"structure"`
// The alias of the Amazon Lex bot.
//
// BotAlias is a required field
BotAlias *string `location:"uri" locationName:"botAlias" type:"string" required:"true"`
// The name of the Amazon Lex bot.
//
// BotName is a required field
BotName *string `location:"uri" locationName:"botName" type:"string" required:"true"`
// The text that the user entered (Amazon Lex interprets this text).
//
// InputText is a required field
InputText *string `locationName:"inputText" min:"1" type:"string" required:"true"`
// By using session attributes, a client application can pass contextual information
// in the request to Amazon Lex For example,
//
// * In Getting Started Exercise 1, the example bot uses the price session
// attribute to maintain the price of the flowers ordered (for example, "Price":25).
// The code hook (the Lambda function) sets this attribute based on the type
// of flowers ordered. For more information, see Review the Details of Information
// Flow (http://docs.aws.amazon.com/lex/latest/dg/gs-bp-details-after-lambda.html).
//
//
// * In the BookTrip bot exercise, the bot uses the currentReservation session
// attribute to maintain slot data during the in-progress conversation to
// book a hotel or book a car. For more information, see Details of Information
// Flow (http://docs.aws.amazon.com/lex/latest/dg/book-trip-detail-flow.html).
//
//
// * You might use the session attributes (key, value pairs) to track the
// requestID of user requests.
//
// Amazon Lex simply passes these session attributes to the Lambda functions
// configured for the intent.
//
// In your Lambda function, you can also use the session attributes for initialization
// and customization (prompts and response cards). Some examples are:
//
// * Initialization - In a pizza ordering bot, if you can pass the user
// location as a session attribute (for example, "Location" : "111 Maple
// street"), then your Lambda function might use this information to determine
// the closest pizzeria to place the order (perhaps to set the storeAddress
// slot value).
//
// * Personalize prompts - For example, you can configure prompts to refer
// to the user name. (For example, "Hey [FirstName], what toppings would
// you like?"). You can pass the user name as a session attribute ("FirstName"
// : "Joe") so that Amazon Lex can substitute the placeholder to provide
// a personalize prompt to the user ("Hey Joe, what toppings would you like?").
//
//
// Amazon Lex does not persist session attributes.
//
// If you configure a code hook for the intent, Amazon Lex passes the incoming
// session attributes to the Lambda function. If you want Amazon Lex to return
// these session attributes back to the client, the Lambda function must return
// them.
//
// If there is no code hook configured for the intent, Amazon Lex simply returns
// the session attributes back to the client application.
SessionAttributes map[string]*string `locationName:"sessionAttributes" type:"map"`
// The ID of the client application user. The application developer decides
// the user IDs. At runtime, each request must include the user ID. Typically,
// each of your application users should have a unique ID. Note the following
// considerations:
//
// * If you want a user to start a conversation on one device and continue
// the conversation on another device, you might choose a user-specific identifier,
// such as a login or Amazon Cognito user ID (assuming your application is
// using Amazon Cognito).
//
// * If you want the same user to be able to have two independent conversations
// on two different devices, you might choose a device-specific identifier,
// such as device ID, or some globally unique identifier.
//
// UserId is a required field
UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"`
}
// String returns the string representation
func (s PostTextInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s PostTextInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *PostTextInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "PostTextInput"}
if s.BotAlias == nil {
invalidParams.Add(request.NewErrParamRequired("BotAlias"))
}
if s.BotName == nil {
invalidParams.Add(request.NewErrParamRequired("BotName"))
}
if s.InputText == nil {
invalidParams.Add(request.NewErrParamRequired("InputText"))
}
if s.InputText != nil && len(*s.InputText) < 1 {
invalidParams.Add(request.NewErrParamMinLen("InputText", 1))
}
if s.UserId == nil {
invalidParams.Add(request.NewErrParamRequired("UserId"))
}
if s.UserId != nil && len(*s.UserId) < 2 {
invalidParams.Add(request.NewErrParamMinLen("UserId", 2))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetBotAlias sets the BotAlias field's value.
func (s *PostTextInput) SetBotAlias(v string) *PostTextInput {
s.BotAlias = &v
return s
}
// SetBotName sets the BotName field's value.
func (s *PostTextInput) SetBotName(v string) *PostTextInput {
s.BotName = &v
return s
}
// SetInputText sets the InputText field's value.
func (s *PostTextInput) SetInputText(v string) *PostTextInput {
s.InputText = &v
return s
}
// SetSessionAttributes sets the SessionAttributes field's value.
func (s *PostTextInput) SetSessionAttributes(v map[string]*string) *PostTextInput {
s.SessionAttributes = v
return s
}
// SetUserId sets the UserId field's value.
func (s *PostTextInput) SetUserId(v string) *PostTextInput {
s.UserId = &v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostTextResponse
type PostTextOutput struct {
_ struct{} `type:"structure"`
// Identifies the current state of the user interaction. Amazon Lex returns
// one of the following values as dialogState. The client can optionally use
// this information to customize the user interface.
//
// * ElicitIntent – Amazon Lex wants to elicit user intent.
//
// For example, a user might utter an intent ("I want to order a pizza"). If
// Amazon Lex cannot infer the user intent from this utterance, it will return
// this dialogState.
//
// * ConfirmIntent – Amazon Lex is expecting a "yes" or "no" response.
//
// For example, Amazon Lex wants user confirmation before fulfilling an intent.
//
//
// Instead of a simple "yes" or "no," a user might respond with additional information.
// For example, "yes, but make it thick crust pizza" or "no, I want to order
// a drink". Amazon Lex can process such additional information (in these
// examples, update the crust type slot value, or change intent from OrderPizza
// to OrderDrink).
//
// * ElicitSlot – Amazon Lex is expecting a slot value for the current intent.
//
//
// For example, suppose that in the response Amazon Lex sends this message:
// "What size pizza would you like?". A user might reply with the slot value
// (e.g., "medium"). The user might also provide additional information in
// the response (e.g., "medium thick crust pizza"). Amazon Lex can process
// such additional information appropriately.
//
// * Fulfilled – Conveys that the Lambda function configured for the intent
// has successfully fulfilled the intent.
//