/
api_op_GetBot.go
217 lines (187 loc) · 7.71 KB
/
api_op_GetBot.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package lexmodelbuildingservice
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/lexmodelbuildingservice/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Returns metadata information for a specific bot. You must provide the bot name
// and the bot version or alias. This operation requires permissions for the
// lex:GetBot action.
func (c *Client) GetBot(ctx context.Context, params *GetBotInput, optFns ...func(*Options)) (*GetBotOutput, error) {
if params == nil {
params = &GetBotInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetBot", params, optFns, addOperationGetBotMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetBotOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetBotInput struct {
// The name of the bot. The name is case sensitive.
//
// This member is required.
Name *string
// The version or alias of the bot.
//
// This member is required.
VersionOrAlias *string
}
type GetBotOutput struct {
// The message that Amazon Lex returns when the user elects to end the conversation
// without completing it. For more information, see PutBot.
AbortStatement *types.Statement
// Checksum of the bot used to identify a specific revision of the bot's $LATEST
// version.
Checksum *string
// For each Amazon Lex bot created with the Amazon Lex Model Building Service, you
// must specify whether your use of Amazon Lex is related to a website, program, or
// other application that is directed or targeted, in whole or in part, to children
// under age 13 and subject to the Children's Online Privacy Protection Act (COPPA)
// by specifying true or false in the childDirected field. By specifying true in
// the childDirected field, you confirm that your use of Amazon Lex is related to a
// website, program, or other application that is directed or targeted, in whole or
// in part, to children under age 13 and subject to COPPA. By specifying false in
// the childDirected field, you confirm that your use of Amazon Lex is not related
// to a website, program, or other application that is directed or targeted, in
// whole or in part, to children under age 13 and subject to COPPA. You may not
// specify a default value for the childDirected field that does not accurately
// reflect whether your use of Amazon Lex is related to a website, program, or
// other application that is directed or targeted, in whole or in part, to children
// under age 13 and subject to COPPA. If your use of Amazon Lex relates to a
// website, program, or other application that is directed in whole or in part, to
// children under age 13, you must obtain any required verifiable parental consent
// under COPPA. For information regarding the use of Amazon Lex in connection with
// websites, programs, or other applications that are directed or targeted, in
// whole or in part, to children under age 13, see the Amazon Lex FAQ.
// (https://aws.amazon.com/lex/faqs#data-security)
ChildDirected *bool
// The message Amazon Lex uses when it doesn't understand the user's request. For
// more information, see PutBot.
ClarificationPrompt *types.Prompt
// The date that the bot was created.
CreatedDate *time.Time
// A description of the bot.
Description *string
// Indicates whether user utterances should be sent to Amazon Comprehend for
// sentiment analysis.
DetectSentiment *bool
// Indicates whether the bot uses accuracy improvements. true indicates that the
// bot is using the improvements, otherwise, false.
EnableModelImprovements *bool
// If status is FAILED, Amazon Lex explains why it failed to build the bot.
FailureReason *string
// The maximum time in seconds that Amazon Lex retains the data gathered in a
// conversation. For more information, see PutBot.
IdleSessionTTLInSeconds *int32
// An array of intent objects. For more information, see PutBot.
Intents []types.Intent
// The date that the bot was updated. When you create a resource, the creation date
// and last updated date are the same.
LastUpdatedDate *time.Time
// The target locale for the bot.
Locale types.Locale
// The name of the bot.
Name *string
// The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent,
// AMAZON.KendraSearchIntent, or both when returning alternative intents in a
// PostContent
// (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) or
// PostText (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html)
// response. AMAZON.FallbackIntent is inserted if the confidence score for all
// intents is below this value. AMAZON.KendraSearchIntent is only inserted if it is
// configured for the bot.
NluIntentConfidenceThreshold *float64
// The status of the bot. When the status is BUILDING Amazon Lex is building the
// bot for testing and use. If the status of the bot is READY_BASIC_TESTING, you
// can test the bot using the exact utterances specified in the bot's intents. When
// the bot is ready for full testing or to run, the status is READY. If there was a
// problem with building the bot, the status is FAILED and the failureReason field
// explains why the bot did not build. If the bot was saved but not built, the
// status is NOT_BUILT.
Status types.Status
// The version of the bot. For a new bot, the version is always $LATEST.
Version *string
// The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the
// user. For more information, see PutBot.
VoiceId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
}
func addOperationGetBotMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetBot{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetBot{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpGetBotValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetBot(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opGetBot(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "lex",
OperationName: "GetBot",
}
}