/
api_op_ListUtteranceAnalyticsData.go
291 lines (251 loc) · 9.68 KB
/
api_op_ListUtteranceAnalyticsData.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package lexmodelsv2
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/lexmodelsv2/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// To use this API operation, your IAM role must have permissions to perform the
// ListAggregatedUtterances (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html)
// operation, which provides access to utterance-related analytics. See Viewing
// utterance statistics (https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html)
// for the IAM policy to apply to the IAM role. Retrieves a list of metadata for
// individual user utterances to your bot. The following fields are required:
// - startDateTime and endDateTime – Define a time range for which you want to
// retrieve results.
//
// Of the optional fields, you can organize the results in the following ways:
// - Use the filters field to filter the results and the sortBy field to specify
// the values by which to sort the results.
// - Use the maxResults field to limit the number of results to return in a
// single response and the nextToken field to return the next batch of results if
// the response does not return the full set of results.
func (c *Client) ListUtteranceAnalyticsData(ctx context.Context, params *ListUtteranceAnalyticsDataInput, optFns ...func(*Options)) (*ListUtteranceAnalyticsDataOutput, error) {
if params == nil {
params = &ListUtteranceAnalyticsDataInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListUtteranceAnalyticsData", params, optFns, c.addOperationListUtteranceAnalyticsDataMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListUtteranceAnalyticsDataOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListUtteranceAnalyticsDataInput struct {
// The identifier for the bot for which you want to retrieve utterance analytics.
//
// This member is required.
BotId *string
// The date and time that marks the end of the range of time for which you want to
// see utterance analytics.
//
// This member is required.
EndDateTime *time.Time
// The date and time that marks the beginning of the range of time for which you
// want to see utterance analytics.
//
// This member is required.
StartDateTime *time.Time
// A list of objects, each of which describes a condition by which you want to
// filter the results.
Filters []types.AnalyticsUtteranceFilter
// The maximum number of results to return in each page of results. If there are
// fewer results than the maximum page size, only the actual number of results are
// returned.
MaxResults *int32
// If the response from the ListUtteranceAnalyticsData operation contains more
// results than specified in the maxResults parameter, a token is returned in the
// response. Use the returned token in the nextToken parameter of a
// ListUtteranceAnalyticsData request to return the next page of results. For a
// complete set of results, call the ListUtteranceAnalyticsData operation until the
// nextToken returned in the response is null.
NextToken *string
// An object specifying the measure and method by which to sort the utterance
// analytics data.
SortBy *types.UtteranceDataSortBy
noSmithyDocumentSerde
}
type ListUtteranceAnalyticsDataOutput struct {
// The unique identifier of the bot that the utterances belong to.
BotId *string
// If the response from the ListUtteranceAnalyticsData operation contains more
// results than specified in the maxResults parameter, a token is returned in the
// response. Use the returned token in the nextToken parameter of a
// ListUtteranceAnalyticsData request to return the next page of results. For a
// complete set of results, call the ListUtteranceAnalyticsData operation until the
// nextToken returned in the response is null.
NextToken *string
// A list of objects, each of which contains information about an utterance in a
// user session with your bot.
Utterances []types.UtteranceSpecification
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListUtteranceAnalyticsDataMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpListUtteranceAnalyticsData{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListUtteranceAnalyticsData{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "ListUtteranceAnalyticsData"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpListUtteranceAnalyticsDataValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListUtteranceAnalyticsData(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); 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
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
// ListUtteranceAnalyticsDataAPIClient is a client that implements the
// ListUtteranceAnalyticsData operation.
type ListUtteranceAnalyticsDataAPIClient interface {
ListUtteranceAnalyticsData(context.Context, *ListUtteranceAnalyticsDataInput, ...func(*Options)) (*ListUtteranceAnalyticsDataOutput, error)
}
var _ ListUtteranceAnalyticsDataAPIClient = (*Client)(nil)
// ListUtteranceAnalyticsDataPaginatorOptions is the paginator options for
// ListUtteranceAnalyticsData
type ListUtteranceAnalyticsDataPaginatorOptions struct {
// The maximum number of results to return in each page of results. If there are
// fewer results than the maximum page size, only the actual number of results are
// returned.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListUtteranceAnalyticsDataPaginator is a paginator for
// ListUtteranceAnalyticsData
type ListUtteranceAnalyticsDataPaginator struct {
options ListUtteranceAnalyticsDataPaginatorOptions
client ListUtteranceAnalyticsDataAPIClient
params *ListUtteranceAnalyticsDataInput
nextToken *string
firstPage bool
}
// NewListUtteranceAnalyticsDataPaginator returns a new
// ListUtteranceAnalyticsDataPaginator
func NewListUtteranceAnalyticsDataPaginator(client ListUtteranceAnalyticsDataAPIClient, params *ListUtteranceAnalyticsDataInput, optFns ...func(*ListUtteranceAnalyticsDataPaginatorOptions)) *ListUtteranceAnalyticsDataPaginator {
if params == nil {
params = &ListUtteranceAnalyticsDataInput{}
}
options := ListUtteranceAnalyticsDataPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListUtteranceAnalyticsDataPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListUtteranceAnalyticsDataPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListUtteranceAnalyticsData page.
func (p *ListUtteranceAnalyticsDataPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUtteranceAnalyticsDataOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListUtteranceAnalyticsData(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListUtteranceAnalyticsData(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "ListUtteranceAnalyticsData",
}
}