// 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/aws/signer/v4" "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) { 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 = 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, 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 = addOpListUtteranceAnalyticsDataValidationMiddleware(stack); err != nil { return err } if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListUtteranceAnalyticsData(options.Region), middleware.Before); err != nil { return err } if err = awsmiddleware.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 } 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, SigningName: "lex", OperationName: "ListUtteranceAnalyticsData", } }