AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Lex Model Building V2 ListAggregatedUtterances API operation.

Syntax

Get-LMBV2AggregatedUtteranceList
-BotId <String>
-SortBy_Attribute <AggregatedUtterancesSortAttribute>
-BotAliasId <String>
-BotVersion <String>
-Filter <AggregatedUtterancesFilter[]>
-LocaleId <String>
-SortBy_Order <SortOrder>
-RelativeAggregationDuration_TimeDimension <TimeDimension>
-RelativeAggregationDuration_TimeValue <Int32>
-MaxResult <Int32>
-NextToken <String>
-Select <String>
-PassThru <SwitchParameter>

Description

Provides a list of utterances that users have sent to the bot. Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase "I want to order pizza" are aggregated into the same line in the response. You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent. Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time. Utterances statistics are not generated under the following conditions:
  • The childDirected field was set to true when the bot was created.
  • You are using slot obfuscation with one or more slots.
  • You opted out of participating in improving Amazon Lex.

Parameters

-BotAliasId <String>
The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BotId <String>
The unique identifier of the bot associated with this request.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-BotVersion <String>
The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters
-LocaleId <String>
The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxResult <Int32>
The maximum number of utterances 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. If you don't specify the maxResults parameter, 1,000 results are returned.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxResults
-NextToken <String>
If the response from the ListAggregatedUtterances operation contains more results that specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the BotId parameter. The -PassThru parameter is deprecated, use -Select '^BotId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RelativeAggregationDuration_TimeDimension <TimeDimension>
The type of time period that the timeValue field represents.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAggregationDuration_RelativeAggregationDuration_TimeDimension
-RelativeAggregationDuration_TimeValue <Int32>
The period of the time window to gather statistics for. The valid value depends on the setting of the timeDimension field.
  • Hours - 1/3/6/12/24
  • Days - 3
  • Weeks - 1/2
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAggregationDuration_RelativeAggregationDuration_TimeValue
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LexModelsV2.Model.ListAggregatedUtterancesResponse). Specifying the name of a property of type Amazon.LexModelsV2.Model.ListAggregatedUtterancesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
The utterance attribute to sort by.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SortBy_Order <SortOrder>
Specifies whether to sort the aggregated utterances in ascending or descending order.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.LexModelsV2.Model.ListAggregatedUtterancesResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z