Returns a list of all the scans in an account.
" + "documentation":"Returns a list of all the standard scans in an account. Does not return express scans.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -456,7 +456,7 @@ "members":{ "analysisType":{ "shape":"AnalysisType", - "documentation":"The type of analysis you want CodeGuru Security to perform in the scan, either Security or All. The Secuirty type only generates findings related to security. The All type generates both security findings and quality findings. Defaults to Security type if missing.
The type of analysis you want CodeGuru Security to perform in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings. Defaults to Security type if missing.
Information about a security vulnerability that Amazon CodeGuru Security detected.
" } }, - "documentation":"This section provides documentation for the Amazon CodeGuru Security API operations. CodeGuru Security is a service that uses program analysis and machine learning to detect security policy violations and vulnerabilities, and recommends ways to address these security risks.
By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the Amazon CodeGuru Security User Guide.
" + "documentation":"Amazon CodeGuru Security is in preview release and is subject to change.
This section provides documentation for the Amazon CodeGuru Security API operations. CodeGuru Security is a service that uses program analysis and machine learning to detect security policy violations and vulnerabilities, and recommends ways to address these security risks.
By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the Amazon CodeGuru Security User Guide.
" } diff --git a/botocore/data/connect/2017-08-08/service-2.json b/botocore/data/connect/2017-08-08/service-2.json index 1cc5b2c287..99d6c7c7e8 100644 --- a/botocore/data/connect/2017-08-08/service-2.json +++ b/botocore/data/connect/2017-08-08/service-2.json @@ -8481,7 +8481,7 @@ }, "Filters":{ "shape":"FiltersV2List", - "documentation":"The filters to apply to returned metrics. You can filter on the following resources:
Queues
Routing profiles
Agents
Channels
User hierarchy groups
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
The filters to apply to returned metrics. You can filter on the following resources:
Queues
Routing profiles
Agents
Channels
User hierarchy groups
Feature
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | FEATURE
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide.
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide.
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile
Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.
" }, + "ListIntentMetrics":{ + "name":"ListIntentMetrics", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/analytics/intentmetrics", + "responseCode":200 + }, + "input":{"shape":"ListIntentMetricsRequest"}, + "output":{"shape":"ListIntentMetricsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves summary metrics for the intents in your bot. The following fields are required:
metrics – A list of AnalyticsIntentMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.
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, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group 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.
Note that an order field exists in both binBy and metrics. You can specify only one order in a given request.
Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required:
startDateTime and endDateTime – Define a time range for which you want to retrieve results.
intentPath – Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate the intentPath field with /BookCar/BookHotel to see details about how many times users invoked the BookCar and BookHotel intents in that order.
Use the optional filters field to filter the results.
Retrieves summary metrics for the intent stages in your bot. The following fields are required:
metrics – A list of AnalyticsIntentStageMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.
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, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group 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.
Note that an order field exists in both binBy and metrics. You can only specify one order in a given request.
Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.
" }, + "ListSessionAnalyticsData":{ + "name":"ListSessionAnalyticsData", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/analytics/sessions", + "responseCode":200 + }, + "input":{"shape":"ListSessionAnalyticsDataRequest"}, + "output":{"shape":"ListSessionAnalyticsDataResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields 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.
Retrieves summary metrics for the user sessions with your bot. The following fields are required:
metrics – A list of AnalyticsSessionMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.
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, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group 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.
Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.
The list of the test sets
" }, + "ListUtteranceAnalyticsData":{ + "name":"ListUtteranceAnalyticsData", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/analytics/utterances", + "responseCode":200 + }, + "input":{"shape":"ListUtteranceAnalyticsDataRequest"}, + "output":{"shape":"ListUtteranceAnalyticsDataResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Retrieves a list of metadata for individual user utterances to your bot. The startDateTime and endDateTime fields are required. These fields 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.
Retrieves summary metrics for the utterances in your bot. The following fields are required:
metrics – A list of AnalyticsUtteranceMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.
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, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group 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.
Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.
Indicates whether audio input is allowed.
" + "allowAudioInput":{ + "shape":"BoxedBoolean", + "documentation":"Indicates whether audio input is allowed.
" + }, + "allowDTMFInput":{ + "shape":"BoxedBoolean", + "documentation":"Indicates whether DTMF input is allowed.
" + } + }, + "documentation":"Specifies the allowed input types.
" + }, + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1 + }, + "AnalyticsBinByList":{ + "type":"list", + "member":{"shape":"AnalyticsBinBySpecification"}, + "max":1, + "min":1 + }, + "AnalyticsBinByName":{ + "type":"string", + "enum":[ + "ConversationStartTime", + "UtteranceTimestamp" + ] + }, + "AnalyticsBinBySpecification":{ + "type":"structure", + "required":[ + "name", + "interval" + ], + "members":{ + "name":{ + "shape":"AnalyticsBinByName", + "documentation":"Specifies the time metric by which to bin the analytics data.
" + }, + "interval":{ + "shape":"AnalyticsInterval", + "documentation":"Specifies the interval of time by which to bin the analytics data.
" + }, + "order":{ + "shape":"AnalyticsSortOrder", + "documentation":"Specifies whether to bin the analytics data in ascending or descending order. If this field is left blank, the default order is by the key of the bin in descending order.
" + } + }, + "documentation":"Contains the time metric, interval, and method by which to bin the analytics data.
" + }, + "AnalyticsBinKey":{ + "type":"structure", + "members":{ + "name":{ + "shape":"AnalyticsBinByName", + "documentation":"The criterion by which to bin the results.
" + }, + "value":{ + "shape":"AnalyticsBinValue", + "documentation":"The value of the criterion that defines the bin.
" + } + }, + "documentation":"An object containing the criterion by which to bin the results and the value that defines that bin.
" + }, + "AnalyticsBinKeys":{ + "type":"list", + "member":{"shape":"AnalyticsBinKey"}, + "max":1, + "min":1 + }, + "AnalyticsBinValue":{"type":"long"}, + "AnalyticsCommonFilterName":{ + "type":"string", + "enum":[ + "BotAliasId", + "BotVersion", + "LocaleId", + "Modality", + "Channel" + ] + }, + "AnalyticsFilterOperator":{ + "type":"string", + "enum":[ + "EQ", + "GT", + "LT" + ] + }, + "AnalyticsFilterValue":{"type":"string"}, + "AnalyticsFilterValues":{ + "type":"list", + "member":{"shape":"AnalyticsFilterValue"}, + "max":5, + "min":1 + }, + "AnalyticsGroupByValue":{"type":"string"}, + "AnalyticsIntentField":{ + "type":"string", + "enum":[ + "IntentName", + "IntentEndState", + "IntentLevel" + ] + }, + "AnalyticsIntentFilter":{ + "type":"structure", + "required":[ + "name", + "operator", + "values" + ], + "members":{ + "name":{ + "shape":"AnalyticsIntentFilterName", + "documentation":"The category by which to filter the intents. The descriptions for each option are as follows:
BotAlias – The name of the bot alias.
BotVersion – The version of the bot.
LocaleId – The locale of the bot.
Modality – The modality of the session with the bot (audio, DTMF, or text).
Channel – The channel that the bot is integrated with.
SessionId – The identifier of the session with the bot.
OriginatingRequestId – The identifier of the first request in a session.
IntentName – The name of the intent.
IntentEndState – The final state of the intent.
The operation by which to filter the category. The following operations are possible:
CO – Contains
EQ – Equals
GT – Greater than
LT – Less than
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
SessionId – EQ.
OriginatingRequestId – EQ.
IntentName – EQ, CO.
IntentEndState – EQ, CO.
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.
Contains fields describing a condition by which to filter the intents. The expression may be understood as name operator values. For example:
IntentName CO Book – The intent name contains the string \"Book.\"
BotVersion EQ 2 – The bot version is equal to two.
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
SessionId – EQ.
OriginatingRequestId – EQ.
IntentName – EQ, CO.
IntentEndState – EQ, CO.
A category by which the intent analytics were grouped.
" + }, + "value":{ + "shape":"AnalyticsGroupByValue", + "documentation":"A member of the category by which the intent analytics were grouped.
" + } + }, + "documentation":"Contains the category by which the intent analytics were grouped and a member of that category.
" + }, + "AnalyticsIntentGroupByKeys":{ + "type":"list", + "member":{"shape":"AnalyticsIntentGroupByKey"} + }, + "AnalyticsIntentGroupByList":{ + "type":"list", + "member":{"shape":"AnalyticsIntentGroupBySpecification"}, + "max":3, + "min":1 + }, + "AnalyticsIntentGroupBySpecification":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"AnalyticsIntentField", + "documentation":"Specifies whether to group the intent stages by their name or their end state.
" + } + }, + "documentation":"Contains the category by which to group the intents.
" + }, + "AnalyticsIntentMetric":{ + "type":"structure", + "required":[ + "name", + "statistic" + ], + "members":{ + "name":{ + "shape":"AnalyticsIntentMetricName", + "documentation":"The metric for which you want to get intent summary statistics.
Count – The number of times the intent was invoked.
Success – The number of times the intent succeeded.
Failure – The number of times the intent failed.
Switched – The number of times there was a switch to a different intent.
Dropped – The number of times the user dropped the intent.
The summary statistic to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of intents in the category you provide in name.
Max – The highest count in the category you provide in name.
Specifies whether to sort the results in ascending or descending order.
" + } + }, + "documentation":"Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the intents in the bot.
" + }, + "AnalyticsIntentMetricName":{ + "type":"string", + "enum":[ + "Count", + "Success", + "Failure", + "Switched", + "Dropped" + ] + }, + "AnalyticsIntentMetricResult":{ + "type":"structure", + "members":{ + "name":{ + "shape":"AnalyticsIntentMetricName", + "documentation":"The metric that you requested. See Key definitions for more details about these metrics.
Count – The number of times the intent was invoked.
Success – The number of times the intent succeeded.
Failure – The number of times the intent failed.
Switched – The number of times there was a switch to a different intent.
Dropped – The number of times the user dropped the intent.
The statistic that you requested to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of intents in the category you provide in name.
Max – The highest count in the category you provide in name.
The value of the summary statistic for the metric that you requested.
" + } + }, + "documentation":"An object containing the results for the intent metric you requested.
" + }, + "AnalyticsIntentMetricResults":{ + "type":"list", + "member":{"shape":"AnalyticsIntentMetricResult"} + }, + "AnalyticsIntentMetrics":{ + "type":"list", + "member":{"shape":"AnalyticsIntentMetric"}, + "max":5, + "min":1 + }, + "AnalyticsIntentNodeSummaries":{ + "type":"list", + "member":{"shape":"AnalyticsIntentNodeSummary"}, + "max":100, + "min":1 + }, + "AnalyticsIntentNodeSummary":{ + "type":"structure", + "members":{ + "intentName":{ + "shape":"Name", + "documentation":"The name of the intent at the end of the requested path.
" + }, + "intentPath":{ + "shape":"AnalyticsPath", + "documentation":"The path.
" + }, + "intentCount":{ + "shape":"AnalyticsNodeCount", + "documentation":"The total number of sessions that follow the given path to the given intent.
" + }, + "intentLevel":{ + "shape":"AnalyticsNodeLevel", + "documentation":"The number of intents up to and including the requested path.
" + }, + "nodeType":{ + "shape":"AnalyticsNodeType", + "documentation":"Specifies whether the node is the end of a path (Exit) or not (Inner).
An object containing information about the requested path.
" + }, + "AnalyticsIntentResult":{ + "type":"structure", + "members":{ + "binKeys":{ + "shape":"AnalyticsBinKeys", + "documentation":"A list of objects containing the criteria you requested for binning results and the values of the bins.
" + }, + "groupByKeys":{ + "shape":"AnalyticsIntentGroupByKeys", + "documentation":"A list of objects containing the criteria you requested for grouping results and the values of the groups.
" + }, + "metricsResults":{ + "shape":"AnalyticsIntentMetricResults", + "documentation":"A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
" + } + }, + "documentation":"An object containing the results for the intent metrics you requested and the bin and/or group(s) they refer to, if applicable.
" + }, + "AnalyticsIntentResults":{ + "type":"list", + "member":{"shape":"AnalyticsIntentResult"} + }, + "AnalyticsIntentStageField":{ + "type":"string", + "enum":[ + "IntentStageName", + "SwitchedToIntent" + ] + }, + "AnalyticsIntentStageFilter":{ + "type":"structure", + "required":[ + "name", + "operator", + "values" + ], + "members":{ + "name":{ + "shape":"AnalyticsIntentStageFilterName", + "documentation":"The category by which to filter the intent stages. The descriptions for each option are as follows:
BotAlias – The name of the bot alias.
BotVersion – The version of the bot.
LocaleId – The locale of the bot.
Modality – The modality of the session with the bot (audio, DTMF, or text).
Channel – The channel that the bot is integrated with.
SessionId – The identifier of the session with the bot.
OriginatingRequestId – The identifier of the first request in a session.
IntentName – The name of the intent.
IntentStageName – The stage in the intent.
The operation by which to filter the category. The following operations are possible:
CO – Contains
EQ – Equals
GT – Greater than
LT – Less than
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
SessionId – EQ.
OriginatingRequestId – EQ.
IntentName – EQ, CO.
IntentStageName – EQ, CO.
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.
Contains fields describing a condition by which to filter the intent stages. The expression may be understood as name operator values. For example:
IntentName CO Book – The intent name contains the string \"Book.\"
BotVersion EQ 2 – The bot version is equal to two.
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
SessionId – EQ.
OriginatingRequestId – EQ.
IntentName – EQ, CO.
IntentStageName – EQ, CO.
A category by which the intent stage analytics were grouped.
" + }, + "value":{ + "shape":"AnalyticsGroupByValue", + "documentation":"A member of the category by which the intent stage analytics were grouped.
" + } + }, + "documentation":"Contains the category by which the intent stage analytics and the values for that category were grouped.
" + }, + "AnalyticsIntentStageGroupByKeys":{ + "type":"list", + "member":{"shape":"AnalyticsIntentStageGroupByKey"} + }, + "AnalyticsIntentStageGroupByList":{ + "type":"list", + "member":{"shape":"AnalyticsIntentStageGroupBySpecification"}, + "max":2, + "min":1 + }, + "AnalyticsIntentStageGroupBySpecification":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"AnalyticsIntentStageField", + "documentation":"Specifies whether to group the intent stages by their name or the intent to which the session was switched.
" + } + }, + "documentation":"Contains the category by which to group the intent stages.
" + }, + "AnalyticsIntentStageMetric":{ + "type":"structure", + "required":[ + "name", + "statistic" + ], + "members":{ + "name":{ + "shape":"AnalyticsIntentStageMetricName", + "documentation":"The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.
Count – The number of times the intent stage occurred.
Success – The number of times the intent stage succeeded.
Failure – The number of times the intent stage failed.
Dropped – The number of times the user dropped the intent stage.
Retry – The number of times the bot tried to elicit a response from the user at this stage.
The summary statistic to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of intent stages in the category you provide in name.
Max – The highest count in the category you provide in name.
Specifies whether to sort the results in ascending or descending order of the summary statistic (value in the response).
Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the intent stages across the user sessions with the bot.
" + }, + "AnalyticsIntentStageMetricName":{ + "type":"string", + "enum":[ + "Count", + "Success", + "Failed", + "Dropped", + "Retry" + ] + }, + "AnalyticsIntentStageMetricResult":{ + "type":"structure", + "members":{ + "name":{ + "shape":"AnalyticsIntentStageMetricName", + "documentation":"The metric that you requested.
Count – The number of times the intent stage occurred.
Success – The number of times the intent stage succeeded.
Failure – The number of times the intent stage failed.
Dropped – The number of times the user dropped the intent stage.
Retry – The number of times the bot tried to elicit a response from the user at this stage.
The summary statistic that you requested to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of intent stages in the category you provide in name.
Max – The highest count in the category you provide in name.
The value of the summary statistic for the metric that you requested.
" + } + }, + "documentation":"An object containing the results for an intent stage metric you requested.
" + }, + "AnalyticsIntentStageMetricResults":{ + "type":"list", + "member":{"shape":"AnalyticsIntentStageMetricResult"} + }, + "AnalyticsIntentStageMetrics":{ + "type":"list", + "member":{"shape":"AnalyticsIntentStageMetric"}, + "max":5, + "min":1 + }, + "AnalyticsIntentStageResult":{ + "type":"structure", + "members":{ + "binKeys":{ + "shape":"AnalyticsBinKeys", + "documentation":"A list of objects containing the criteria you requested for binning results and the values of the bins.
" + }, + "groupByKeys":{ + "shape":"AnalyticsIntentStageGroupByKeys", + "documentation":"A list of objects containing the criteria you requested for grouping results and the values of the bins.
" + }, + "metricsResults":{ + "shape":"AnalyticsIntentStageMetricResults", + "documentation":"A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
" + } + }, + "documentation":"An object containing the results for the intent stage metrics you requested and the bin and/or group they refer to, if applicable.
" + }, + "AnalyticsIntentStageResults":{ + "type":"list", + "member":{"shape":"AnalyticsIntentStageResult"} + }, + "AnalyticsInterval":{ + "type":"string", + "enum":[ + "OneHour", + "OneDay" + ] + }, + "AnalyticsLongValue":{"type":"long"}, + "AnalyticsMetricStatistic":{ + "type":"string", + "enum":[ + "Sum", + "Avg", + "Max" + ] + }, + "AnalyticsMetricValue":{"type":"double"}, + "AnalyticsModality":{ + "type":"string", + "enum":[ + "Speech", + "Text", + "DTMF", + "MultiMode" + ] + }, + "AnalyticsNodeCount":{"type":"integer"}, + "AnalyticsNodeLevel":{ + "type":"integer", + "max":100, + "min":0 + }, + "AnalyticsNodeType":{ + "type":"string", + "enum":[ + "Inner", + "Exit" + ] + }, + "AnalyticsOriginatingRequestId":{"type":"string"}, + "AnalyticsPath":{ + "type":"string", + "max":1024, + "min":1 + }, + "AnalyticsPathFilter":{ + "type":"structure", + "required":[ + "name", + "operator", + "values" + ], + "members":{ + "name":{ + "shape":"AnalyticsCommonFilterName", + "documentation":"The category by which to filter the intent paths. The descriptions for each option are as follows:
BotAlias – The name of the bot alias.
BotVersion – The version of the bot.
LocaleId – The locale of the bot.
Modality – The modality of the session with the bot (audio, DTMF, or text).
Channel – The channel that the bot is integrated with.
The operation by which to filter the category. The following operations are possible:
CO – Contains
EQ – Equals
GT – Greater than
LT – Less than
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.
Contains fields describing a condition by which to filter the paths. The expression may be understood as name operator values. For example:
LocaleId EQ en – The locale is \"en\".
BotVersion EQ 2 – The bot version is equal to two.
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
The category by which to filter the sessions. The descriptions for each option are as follows:
BotAlias – The name of the bot alias.
BotVersion – The version of the bot.
LocaleId – The locale of the bot.
Modality – The modality of the session with the bot (audio, DTMF, or text).
Channel – The channel that the bot is integrated with.
Duration – The duration of the session.
conversationEndState – The final state of the session.
SessionId – The identifier of the session with the bot.
OriginatingRequestId – The identifier of the first request in a session.
IntentPath – The order of intents taken in a session.
The operation by which to filter the category. The following operations are possible:
CO – Contains
EQ – Equals
GT – Greater than
LT – Less than
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
Duration – EQ, GT, LT.
conversationEndState – EQ, CO.
SessionId – EQ.
OriginatingRequestId – EQ.
IntentPath – EQ.
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.
Contains fields describing a condition by which to filter the sessions. The expression may be understood as name operator values. For example:
LocaleId EQ en – The locale is \"en\".
Duration GT 200 – The duration is greater than 200 seconds.
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
Duration – EQ, GT, LT.
conversationEndState – EQ, CO.
SessionId – EQ.
OriginatingRequestId – EQ.
IntentPath – EQ.
The category by which the session analytics were grouped.
" + }, + "value":{ + "shape":"AnalyticsGroupByValue", + "documentation":"A member of the category by which the session analytics were grouped.
" + } + }, + "documentation":"Contains the category by which the session analytics were grouped and a member of that category.
" + }, + "AnalyticsSessionGroupByKeys":{ + "type":"list", + "member":{"shape":"AnalyticsSessionGroupByKey"} + }, + "AnalyticsSessionGroupByList":{ + "type":"list", + "member":{"shape":"AnalyticsSessionGroupBySpecification"}, + "max":2, + "min":1 + }, + "AnalyticsSessionGroupBySpecification":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"AnalyticsSessionField", + "documentation":"Specifies whether to group the session by their end state or their locale.
" + } + }, + "documentation":"Contains the category by which to group the sessions.
" + }, + "AnalyticsSessionId":{ + "type":"string", + "pattern":"[0-9a-zA-Z._:-]" + }, + "AnalyticsSessionMetric":{ + "type":"structure", + "required":[ + "name", + "statistic" + ], + "members":{ + "name":{ + "shape":"AnalyticsSessionMetricName", + "documentation":"The metric for which you want to get session summary statistics.
Count – The number of sessions.
Success – The number of sessions that succeeded.
Failure – The number of sessions that failed.
Dropped – The number of sessions that the user dropped.
Duration – The duration of sessions.
TurnsPerSession – The number of turns in the sessions.
Concurrency – The number of sessions occurring in the same period of time.
The summary statistic to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of sessions in the category you provide in name.
Max – The highest count in the category you provide in name.
Specifies whether to sort the results in ascending or descending order.
" + } + }, + "documentation":"Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the user sessions with the bot.
" + }, + "AnalyticsSessionMetricName":{ + "type":"string", + "enum":[ + "Count", + "Success", + "Failure", + "Dropped", + "Duration", + "TurnsPerConversation", + "Concurrency" + ] + }, + "AnalyticsSessionMetricResult":{ + "type":"structure", + "members":{ + "name":{ + "shape":"AnalyticsSessionMetricName", + "documentation":"The metric that you requested.
Count – The number of sessions.
Success – The number of sessions that succeeded.
Failure – The number of sessions that failed.
Dropped – The number of sessions that the user dropped.
Duration – The duration of sessions.
TurnPersession – The number of turns in the sessions.
Concurrency – The number of sessions occurring in the same period of time.
The summary statistic that you requested to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of sessions in the category you provide in name.
Max – The highest count in the category you provide in name.
The value of the summary statistic for the metric that you requested.
" + } + }, + "documentation":"An object containing the results for a session metric you requested.
" + }, + "AnalyticsSessionMetricResults":{ + "type":"list", + "member":{"shape":"AnalyticsSessionMetricResult"} + }, + "AnalyticsSessionMetrics":{ + "type":"list", + "member":{"shape":"AnalyticsSessionMetric"}, + "max":7, + "min":1 + }, + "AnalyticsSessionResult":{ + "type":"structure", + "members":{ + "binKeys":{ + "shape":"AnalyticsBinKeys", + "documentation":"A list of objects containing the criteria you requested for binning results and the values of the bins.
" + }, + "groupByKeys":{ + "shape":"AnalyticsSessionGroupByKeys", + "documentation":"A list of objects containing the criteria you requested for grouping results and the values of the bins.
" + }, + "metricsResults":{ + "shape":"AnalyticsSessionMetricResults", + "documentation":"A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
" + } + }, + "documentation":"An object containing the results for the session metrics you requested and the bin and/or group(s) they refer to, if applicable.
" + }, + "AnalyticsSessionResults":{ + "type":"list", + "member":{"shape":"AnalyticsSessionResult"} + }, + "AnalyticsSessionSortByName":{ + "type":"string", + "enum":[ + "ConversationStartTime", + "NumberOfTurns", + "Duration" + ] + }, + "AnalyticsSortOrder":{ + "type":"string", + "enum":[ + "Ascending", + "Descending" + ] + }, + "AnalyticsUtteranceAttribute":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"AnalyticsUtteranceAttributeName", + "documentation":"An attribute to return. The only available attribute is the intent that the bot mapped the utterance to.
" + } + }, + "documentation":"An object that specifies the last used intent at the time of the utterance as an attribute to return.
" + }, + "AnalyticsUtteranceAttributeName":{ + "type":"string", + "enum":["LastUsedIntent"] + }, + "AnalyticsUtteranceAttributeResult":{ + "type":"structure", + "members":{ + "lastUsedIntent":{ + "shape":"Name", + "documentation":"The intent that the bot mapped the utterance to.
" + } + }, + "documentation":"An object containing the intent that the bot mapped the utterance to.
" + }, + "AnalyticsUtteranceAttributeResults":{ + "type":"list", + "member":{"shape":"AnalyticsUtteranceAttributeResult"} + }, + "AnalyticsUtteranceAttributes":{ + "type":"list", + "member":{"shape":"AnalyticsUtteranceAttribute"}, + "max":1, + "min":1 + }, + "AnalyticsUtteranceField":{ + "type":"string", + "enum":[ + "UtteranceText", + "UtteranceState" + ] + }, + "AnalyticsUtteranceFilter":{ + "type":"structure", + "required":[ + "name", + "operator", + "values" + ], + "members":{ + "name":{ + "shape":"AnalyticsUtteranceFilterName", + "documentation":"The category by which to filter the utterances. The descriptions for each option are as follows:
BotAlias – The name of the bot alias.
BotVersion – The version of the bot.
LocaleId – The locale of the bot.
Modality – The modality of the session with the bot (audio, DTMF, or text).
Channel – The channel that the bot is integrated with.
SessionId – The identifier of the session with the bot.
OriginatingRequestId – The identifier of the first request in a session.
UtteranceState – The state of the utterance.
UtteranceText – The text in the utterance.
The operation by which to filter the category. The following operations are possible:
CO – Contains
EQ – Equals
GT – Greater than
LT – Less than
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
SessionId – EQ.
OriginatingRequestId – EQ.
UtteranceState – EQ.
UtteranceText – EQ, CO.
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.
Contains fields describing a condition by which to filter the utterances. The expression may be understood as name operator values. For example:
LocaleId EQ Book – The locale is the string \"en\".
UtteranceText CO help – The text of the utterance contains the string \"help\".
The operators that each filter supports are listed below:
BotAlias – EQ.
BotVersion – EQ.
LocaleId – EQ.
Modality – EQ.
Channel – EQ.
SessionId – EQ.
OriginatingRequestId – EQ.
UtteranceState – EQ.
UtteranceText – EQ, CO.
The category by which the utterance analytics were grouped.
" + }, + "value":{ + "shape":"AnalyticsGroupByValue", + "documentation":"A member of the category by which the utterance analytics were grouped.
" + } + }, + "documentation":"Contains the category by which the utterance analytics were grouped and the values for that category.
" + }, + "AnalyticsUtteranceGroupByKeys":{ + "type":"list", + "member":{"shape":"AnalyticsUtteranceGroupByKey"} + }, + "AnalyticsUtteranceGroupByList":{ + "type":"list", + "member":{"shape":"AnalyticsUtteranceGroupBySpecification"}, + "max":2, + "min":1 + }, + "AnalyticsUtteranceGroupBySpecification":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"AnalyticsUtteranceField", + "documentation":"Specifies whether to group the utterances by their text or their state.
" + } + }, + "documentation":"Contains the category by which to group the utterances.
" + }, + "AnalyticsUtteranceMetric":{ + "type":"structure", + "required":[ + "name", + "statistic" + ], + "members":{ + "name":{ + "shape":"AnalyticsUtteranceMetricName", + "documentation":"The metric for which you want to get utterance summary statistics.
Count – The number of utterances.
Missed – The number of utterances that Amazon Lex failed to recognize.
Detected – The number of utterances that Amazon Lex managed to detect.
UtteranceTimestamp – The date and time of the utterance.
The summary statistic to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of utterances in the category you provide in name.
Max – The highest count in the category you provide in name.
Specifies whether to sort the results in ascending or descending order.
" + } + }, + "documentation":"Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the utterances across the user sessions with the bot.
" + }, + "AnalyticsUtteranceMetricName":{ + "type":"string", + "enum":[ + "Count", + "Missed", + "Detected", + "UtteranceTimestamp" + ] + }, + "AnalyticsUtteranceMetricResult":{ + "type":"structure", + "members":{ + "name":{ + "shape":"AnalyticsUtteranceMetricName", + "documentation":"The metric that you requested.
Count – The number of utterances.
Missed – The number of utterances that Amazon Lex failed to recognize.
Detected – The number of utterances that Amazon Lex managed to detect.
UtteranceTimeStamp – The date and time of the utterance.
The summary statistic that you requested to calculate.
Sum – The total count for the category you provide in name.
Average – The total count divided by the number of utterances in the category you provide in name.
Max – The highest count in the category you provide in name.
The value of the summary statistic for the metric that you requested.
" + } + }, + "documentation":"An object containing the results for the utterance metric you requested.
" + }, + "AnalyticsUtteranceMetricResults":{ + "type":"list", + "member":{"shape":"AnalyticsUtteranceMetricResult"} + }, + "AnalyticsUtteranceMetrics":{ + "type":"list", + "member":{"shape":"AnalyticsUtteranceMetric"}, + "max":4, + "min":1 + }, + "AnalyticsUtteranceResult":{ + "type":"structure", + "members":{ + "binKeys":{ + "shape":"AnalyticsBinKeys", + "documentation":"A list of objects containing the criteria you requested for binning results and the values of the bins.
" }, - "allowDTMFInput":{ - "shape":"BoxedBoolean", - "documentation":"Indicates whether DTMF input is allowed.
" + "groupByKeys":{ + "shape":"AnalyticsUtteranceGroupByKeys", + "documentation":"A list of objects containing the criteria you requested for grouping results and the values of the bins.
" + }, + "metricsResults":{ + "shape":"AnalyticsUtteranceMetricResults", + "documentation":"A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
" + }, + "attributeResults":{ + "shape":"AnalyticsUtteranceAttributeResults", + "documentation":"A list of objects containing information about the last used intent at the time of an utterance.
" } }, - "documentation":"Specifies the allowed input types.
" + "documentation":"An object containing the results for the utterance metrics you requested and the bin and/or group(s) they refer to, if applicable.
" }, - "AmazonResourceName":{ + "AnalyticsUtteranceResults":{ + "type":"list", + "member":{"shape":"AnalyticsUtteranceResult"} + }, + "AnalyticsUtteranceSortByName":{ "type":"string", - "max":1011, - "min":1 + "enum":["UtteranceTimestamp"] }, "AssociatedTranscript":{ "type":"structure", @@ -2182,6 +3229,14 @@ }, "documentation":"The target Amazon S3 location for the test set execution using a bot alias.
" }, + "BotChannelType":{ + "type":"string", + "enum":[ + "Facebook", + "Slack", + "TwilioSms" + ] + }, "BotExportSpecification":{ "type":"structure", "required":[ @@ -3082,6 +4137,14 @@ "max":20, "min":1 }, + "ConversationEndState":{ + "type":"string", + "enum":[ + "Success", + "Failure", + "Dropped" + ] + }, "ConversationLevelIntentClassificationResultItem":{ "type":"structure", "required":[ @@ -6982,6 +8045,17 @@ }, "documentation":"Specifies attributes for sorting a list of intents.
" }, + "IntentState":{ + "type":"string", + "enum":[ + "Failed", + "Fulfilled", + "InProgress", + "ReadyForFulfillment", + "Waiting", + "FulfillmentInProgress" + ] + }, "IntentStatistics":{ "type":"structure", "members":{ @@ -7040,6 +8114,20 @@ "exception":true, "fault":true }, + "InvokedIntentSample":{ + "type":"structure", + "members":{ + "intentName":{ + "shape":"Name", + "documentation":"The name of an intent that was invoked.
" + } + }, + "documentation":"An object containing the name of an intent that was invoked.
" + }, + "InvokedIntentSamples":{ + "type":"list", + "member":{"shape":"InvokedIntentSample"} + }, "ItemId":{ "type":"string", "max":32, @@ -7693,6 +8781,180 @@ } } }, + "ListIntentMetricsRequest":{ + "type":"structure", + "required":[ + "botId", + "startDateTime", + "endDateTime", + "metrics" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier for the bot for which you want to retrieve intent metrics.
", + "location":"uri", + "locationName":"botId" + }, + "startDateTime":{ + "shape":"Timestamp", + "documentation":"The timestamp that marks the beginning of the range of time for which you want to see intent metrics.
" + }, + "endDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that marks the end of the range of time for which you want to see intent metrics.
" + }, + "metrics":{ + "shape":"AnalyticsIntentMetrics", + "documentation":"A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the order by which to organize the results.
" + }, + "binBy":{ + "shape":"AnalyticsBinByList", + "documentation":"A list of objects, each of which contains specifications for organizing the results by time.
" + }, + "groupBy":{ + "shape":"AnalyticsIntentGroupByList", + "documentation":"A list of objects, each of which specifies how to group the results. You can group by the following criteria:
IntentName – The name of the intent.
IntentEndState – The final state of the intent. The possible end states are detailed in Key definitions in the user guide.
A list of objects, each of which describes a condition by which you want to filter the results.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"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.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListIntentMetrics 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 ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.
" + } + } + }, + "ListIntentMetricsResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier for the bot for which you retrieved intent metrics.
" + }, + "results":{ + "shape":"AnalyticsIntentResults", + "documentation":"The results for the intent metrics.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListIntentMetrics 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 ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.
" + } + } + }, + "ListIntentPathsRequest":{ + "type":"structure", + "required":[ + "botId", + "startDateTime", + "endDateTime", + "intentPath" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier for the bot for which you want to retrieve intent path metrics.
", + "location":"uri", + "locationName":"botId" + }, + "startDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that marks the beginning of the range of time for which you want to see intent path metrics.
" + }, + "endDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that marks the end of the range of time for which you want to see intent path metrics.
" + }, + "intentPath":{ + "shape":"AnalyticsPath", + "documentation":"The intent path for which you want to retrieve metrics. Use a forward slash to separate intents in the path. For example:
/BookCar
/BookCar/BookHotel
/BookHotel/BookCar
A list of objects, each describes a condition by which you want to filter the results.
" + } + } + }, + "ListIntentPathsResponse":{ + "type":"structure", + "members":{ + "nodeSummaries":{ + "shape":"AnalyticsIntentNodeSummaries", + "documentation":"A list of objects, each of which contains information about a node in the intent path for which you requested metrics.
" + } + } + }, + "ListIntentStageMetricsRequest":{ + "type":"structure", + "required":[ + "botId", + "startDateTime", + "endDateTime", + "metrics" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier for the bot for which you want to retrieve intent stage metrics.
", + "location":"uri", + "locationName":"botId" + }, + "startDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that marks the beginning of the range of time for which you want to see intent stage metrics.
" + }, + "endDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that marks the end of the range of time for which you want to see intent stage metrics.
" + }, + "metrics":{ + "shape":"AnalyticsIntentStageMetrics", + "documentation":"A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
" + }, + "binBy":{ + "shape":"AnalyticsBinByList", + "documentation":"A list of objects, each of which contains specifications for organizing the results by time.
" + }, + "groupBy":{ + "shape":"AnalyticsIntentStageGroupByList", + "documentation":"A list of objects, each of which specifies how to group the results. You can group by the following criteria:
IntentStageName – The name of the intent stage.
SwitchedToIntent – The intent to which the conversation was switched (if any).
A list of objects, each of which describes a condition by which you want to filter the results.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"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.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListIntentStageMetrics 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 ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
" + } + } + }, + "ListIntentStageMetricsResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier for the bot for which you retrieved intent stage metrics.
" + }, + "results":{ + "shape":"AnalyticsIntentStageResults", + "documentation":"The results for the intent stage metrics.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListIntentStageMetrics 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 ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
" + } + } + }, "ListIntentsRequest":{ "type":"structure", "required":[ @@ -7758,79 +9020,202 @@ }, "nextToken":{ "shape":"NextToken", - "documentation":"A token that indicates whether there are more results to return in a response to the ListIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListIntents operation request to get the next page of results.
A token that indicates whether there are more results to return in a response to the ListIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListIntents operation request to get the next page of results.
The unique identifier of the bot associated with the recommended intents.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot that contains the recommended intents.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale of the recommended intents.
", + "location":"uri", + "locationName":"localeId" + }, + "botRecommendationId":{ + "shape":"Id", + "documentation":"The identifier of the bot recommendation that contains the recommended intents.
", + "location":"uri", + "locationName":"botRecommendationId" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListRecommendedIntents operation contains more results than 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.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
" + } + } + }, + "ListRecommendedIntentsResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The unique identifier of the bot associated with the recommended intent.
" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot that contains the intent.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
" + }, + "botRecommendationId":{ + "shape":"Id", + "documentation":"The identifier of the bot recommendation that contains the recommended intent.
" + }, + "summaryList":{ + "shape":"RecommendedIntentSummaryList", + "documentation":"Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A token that indicates whether there are more results to return in a response to the ListRecommendedIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListRecommendedIntents operation request to get the next page of results.
" + } + } + }, + "ListSessionAnalyticsDataRequest":{ + "type":"structure", + "required":[ + "botId", + "startDateTime", + "endDateTime" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier for the bot for which you want to retrieve session analytics.
", + "location":"uri", + "locationName":"botId" + }, + "startDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that marks the beginning of the range of time for which you want to see session analytics.
" + }, + "endDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that marks the end of the range of time for which you want to see session analytics.
" + }, + "sortBy":{ + "shape":"SessionDataSortBy", + "documentation":"An object specifying the measure and method by which to sort the session analytics data.
" + }, + "filters":{ + "shape":"AnalyticsSessionFilters", + "documentation":"A list of objects, each of which describes a condition by which you want to filter the results.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"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.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListSessionAnalyticsData 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 ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
" + } + } + }, + "ListSessionAnalyticsDataResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The unique identifier of the bot that the sessions belong to.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListSessionAnalyticsData 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 ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
" + }, + "sessions":{ + "shape":"SessionSpecifications", + "documentation":"A list of objects, each of which contains information about a session with the bot.
" } } }, - "ListRecommendedIntentsRequest":{ + "ListSessionMetricsRequest":{ "type":"structure", "required":[ "botId", - "botVersion", - "localeId", - "botRecommendationId" + "startDateTime", + "endDateTime", + "metrics" ], "members":{ "botId":{ "shape":"Id", - "documentation":"The unique identifier of the bot associated with the recommended intents.
", + "documentation":"The identifier for the bot for which you want to retrieve session metrics.
", "location":"uri", "locationName":"botId" }, - "botVersion":{ - "shape":"DraftBotVersion", - "documentation":"The version of the bot that contains the recommended intents.
", - "location":"uri", - "locationName":"botVersion" + "startDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that marks the beginning of the range of time for which you want to see session metrics.
" }, - "localeId":{ - "shape":"LocaleId", - "documentation":"The identifier of the language and locale of the recommended intents.
", - "location":"uri", - "locationName":"localeId" + "endDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that marks the end of the range of time for which you want to see session metrics.
" }, - "botRecommendationId":{ - "shape":"Id", - "documentation":"The identifier of the bot recommendation that contains the recommended intents.
", - "location":"uri", - "locationName":"botRecommendationId" + "metrics":{ + "shape":"AnalyticsSessionMetrics", + "documentation":"A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
" }, - "nextToken":{ - "shape":"NextToken", - "documentation":"If the response from the ListRecommendedIntents operation contains more results than 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.
" + "binBy":{ + "shape":"AnalyticsBinByList", + "documentation":"A list of objects, each of which contains specifications for organizing the results by time.
" + }, + "groupBy":{ + "shape":"AnalyticsSessionGroupByList", + "documentation":"A list of objects, each of which specifies how to group the results. You can group by the following criteria:
ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.
LocaleId – The unique identifier of the bot locale.
A list of objects, each of which describes a condition by which you want to filter the results.
" }, "maxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
" + "documentation":"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.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListSessionMetrics 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 ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
" } } }, - "ListRecommendedIntentsResponse":{ + "ListSessionMetricsResponse":{ "type":"structure", "members":{ "botId":{ "shape":"Id", - "documentation":"The unique identifier of the bot associated with the recommended intent.
" - }, - "botVersion":{ - "shape":"DraftBotVersion", - "documentation":"The version of the bot that contains the intent.
" - }, - "localeId":{ - "shape":"LocaleId", - "documentation":"The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
" - }, - "botRecommendationId":{ - "shape":"Id", - "documentation":"The identifier of the bot recommendation that contains the recommended intent.
" + "documentation":"The identifier for the bot for which you retrieved session metrics.
" }, - "summaryList":{ - "shape":"RecommendedIntentSummaryList", - "documentation":"Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.
" + "results":{ + "shape":"AnalyticsSessionResults", + "documentation":"The results for the session metrics.
" }, "nextToken":{ "shape":"NextToken", - "documentation":"A token that indicates whether there are more results to return in a response to the ListRecommendedIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListRecommendedIntents operation request to get the next page of results.
" + "documentation":"If the response from the ListSessionMetrics 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 ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
" } } }, @@ -8137,6 +9522,133 @@ } } }, + "ListUtteranceAnalyticsDataRequest":{ + "type":"structure", + "required":[ + "botId", + "startDateTime", + "endDateTime" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier for the bot for which you want to retrieve utterance analytics.
", + "location":"uri", + "locationName":"botId" + }, + "startDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that marks the beginning of the range of time for which you want to see utterance analytics.
" + }, + "endDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that marks the end of the range of time for which you want to see utterance analytics.
" + }, + "sortBy":{ + "shape":"UtteranceDataSortBy", + "documentation":"An object specifying the measure and method by which to sort the utterance analytics data.
" + }, + "filters":{ + "shape":"AnalyticsUtteranceFilters", + "documentation":"A list of objects, each of which describes a condition by which you want to filter the results.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"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.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
" + } + } + }, + "ListUtteranceAnalyticsDataResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The unique identifier of the bot that the utterances belong to.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
" + }, + "utterances":{ + "shape":"UtteranceSpecifications", + "documentation":"A list of objects, each of which contains information about an utterance in a user session with your bot.
" + } + } + }, + "ListUtteranceMetricsRequest":{ + "type":"structure", + "required":[ + "botId", + "startDateTime", + "endDateTime", + "metrics" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier for the bot for which you want to retrieve utterance metrics.
", + "location":"uri", + "locationName":"botId" + }, + "startDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that marks the beginning of the range of time for which you want to see utterance metrics.
" + }, + "endDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that marks the end of the range of time for which you want to see utterance metrics.
" + }, + "metrics":{ + "shape":"AnalyticsUtteranceMetrics", + "documentation":"A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
" + }, + "binBy":{ + "shape":"AnalyticsBinByList", + "documentation":"A list of objects, each of which contains specifications for organizing the results by time.
" + }, + "groupBy":{ + "shape":"AnalyticsUtteranceGroupByList", + "documentation":"A list of objects, each of which specifies how to group the results. You can group by the following criteria:
UtteranceText – The transcription of the utterance.
UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.
A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:
LastUsedIntent – The last used intent at the time of the utterance.
A list of objects, each of which describes a condition by which you want to filter the results.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"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.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListUtteranceMetrics 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 ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.
" + } + } + }, + "ListUtteranceMetricsResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier for the bot for which you retrieved utterance metrics.
" + }, + "results":{ + "shape":"AnalyticsUtteranceResults", + "documentation":"The results for the utterance metrics.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListUtteranceMetrics 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 ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.
" + } + } + }, "LocaleId":{"type":"string"}, "LocaleName":{"type":"string"}, "LogPrefix":{ @@ -8999,12 +10511,92 @@ "error":{"httpStatusCode":402}, "exception":true }, + "SessionDataSortBy":{ + "type":"structure", + "required":[ + "name", + "order" + ], + "members":{ + "name":{ + "shape":"AnalyticsSessionSortByName", + "documentation":"The measure by which to sort the session analytics data.
conversationStartTime – The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
numberOfTurns – The number of turns that the session took.
conversationDurationSeconds – The duration of the conversation in seconds.
Specifies whether to sort the results in ascending or descending order.
" + } + }, + "documentation":"An object specifying the measure and method by which to sort the session analytics data.
" + }, "SessionId":{ "type":"string", "max":100, "min":2, "pattern":"[0-9a-zA-Z._:-]+" }, + "SessionSpecification":{ + "type":"structure", + "members":{ + "botAliasId":{ + "shape":"BotAliasId", + "documentation":"The identifier of the alias of the bot that the session was held with.
" + }, + "botVersion":{ + "shape":"NumericalBotVersion", + "documentation":"The version of the bot that the session was held with.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The locale of the bot that the session was held with.
" + }, + "channel":{ + "shape":"BotChannelType", + "documentation":"The channel that is integrated with the bot that the session was held with.
" + }, + "sessionId":{ + "shape":"AnalyticsSessionId", + "documentation":"The identifier of the session.
" + }, + "conversationStartTime":{ + "shape":"Timestamp", + "documentation":"The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
The date and time when the conversation ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
The duration of the conversation in seconds. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
The mode of the session. The possible values are as follows:
Speech – The session was spoken.
Text – The session was written.
DTMF – The session used a touch-tone keypad (Dual Tone Multi-Frequency).
MultiMode – The session used multiple modes.
The number of turns that the session took.
" + }, + "invokedIntentSamples":{ + "shape":"InvokedIntentSamples", + "documentation":"A list of objects containing the name of an intent that was invoked.
" + }, + "originatingRequestId":{ + "shape":"AnalyticsOriginatingRequestId", + "documentation":"The identifier of the first request in a session.
" + } + }, + "documentation":"An object containing information about a specific session.
" + }, + "SessionSpecifications":{ + "type":"list", + "member":{"shape":"SessionSpecification"} + }, "SessionTTL":{ "type":"integer", "max":86400, @@ -11814,6 +13406,52 @@ }, "documentation":"Contains information about the audio for an utterance.
" }, + "UtteranceBotResponse":{ + "type":"structure", + "members":{ + "content":{ + "shape":"String", + "documentation":"The text of the response to the utterance from the bot.
" + }, + "contentType":{ + "shape":"UtteranceContentType", + "documentation":"The type of the response. The following values are possible:
PlainText – A plain text string.
CustomPayload – A response string that you can customize to include data or metadata for your application.
SSML – A string that includes Speech Synthesis Markup Language to customize the audio response.
ImageResponseCard – An image with buttons that the customer can select. See ImageResponseCard for more information.
An object that contains a response to the utterance from the bot.
" + }, + "UtteranceBotResponses":{ + "type":"list", + "member":{"shape":"UtteranceBotResponse"} + }, + "UtteranceContentType":{ + "type":"string", + "enum":[ + "PlainText", + "CustomPayload", + "SSML", + "ImageResponseCard" + ] + }, + "UtteranceDataSortBy":{ + "type":"structure", + "required":[ + "name", + "order" + ], + "members":{ + "name":{ + "shape":"AnalyticsUtteranceSortByName", + "documentation":"The measure by which to sort the utterance analytics data.
Count – The number of utterances.
UtteranceTimeStamp – The date and time of the utterance.
Specifies whether to sort the results in ascending or descending order.
" + } + }, + "documentation":"An object specifying the measure and method by which to sort the utterance data.
" + }, "UtteranceInputSpecification":{ "type":"structure", "members":{ @@ -11865,6 +13503,105 @@ }, "documentation":"Contains information about the utterances in the results of the test set execution.
" }, + "UtteranceSpecification":{ + "type":"structure", + "members":{ + "botAliasId":{ + "shape":"BotAliasId", + "documentation":"The identifier of the alias of the bot that the utterance was made to.
" + }, + "botVersion":{ + "shape":"NumericalBotVersion", + "documentation":"The version of the bot that the utterance was made to.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The locale of the bot that the utterance was made to.
" + }, + "sessionId":{ + "shape":"AnalyticsSessionId", + "documentation":"The identifier of the session that the utterance was made in.
" + }, + "channel":{ + "shape":"BotChannelType", + "documentation":"The channel that is integrated with the bot that the utterance was made to.
" + }, + "mode":{ + "shape":"AnalyticsModality", + "documentation":"The mode of the session. The possible values are as follows:
Speech – The session consisted of spoken dialogue.
Text – The session consisted of written dialogue.
DTMF – The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.
MultiMode – The session consisted of multiple modes.
The date and time when the conversation in which the utterance took place began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
The date and time when the conversation in which the utterance took place ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
The text of the utterance.
" + }, + "utteranceTimestamp":{ + "shape":"Timestamp", + "documentation":"The date and time when the utterance took place.
" + }, + "audioVoiceDurationMillis":{ + "shape":"AnalyticsLongValue", + "documentation":"The duration in milliseconds of the audio associated with the utterance.
" + }, + "utteranceUnderstood":{ + "shape":"UtteranceUnderstood", + "documentation":"Specifies whether the bot understood the utterance or not.
" + }, + "inputType":{ + "shape":"String", + "documentation":"The input type of the utterance. The possible values are as follows:
PCM format: audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
The output type of the utterance. The possible values are as follows:
audio/mpeg
audio/ogg
audio/pcm (16 KHz)
audio/ (defaults to mpeg)
text/plain; charset=utf-8
The name of the intent that the utterance is associated to.
" + }, + "associatedSlotName":{ + "shape":"Name", + "documentation":"The name of the slot that the utterance is associated to.
" + }, + "intentState":{ + "shape":"IntentState", + "documentation":"The state of the intent that the utterance is associated to.
" + }, + "dialogActionType":{ + "shape":"String", + "documentation":"The type of dialog action that the utterance is associated to. See the type field in DialogAction for more information.
The identifier for the audio of the bot response.
" + }, + "slotsFilledInSession":{ + "shape":"String", + "documentation":"The slots that have been filled in the session by the time of the utterance.
" + }, + "utteranceRequestId":{ + "shape":"Id", + "documentation":"The identifier of the request associated with the utterance.
" + }, + "botResponses":{ + "shape":"UtteranceBotResponses", + "documentation":"A list of objects containing information about the bot response to the utterance.
" + } + }, + "documentation":"An object containing information about a specific utterance.
" + }, + "UtteranceSpecifications":{ + "type":"list", + "member":{"shape":"UtteranceSpecification"} + }, + "UtteranceUnderstood":{"type":"boolean"}, "ValidationException":{ "type":"structure", "members":{ diff --git a/botocore/data/m2/2021-04-28/service-2.json b/botocore/data/m2/2021-04-28/service-2.json index f5c8407229..b0dd487538 100644 --- a/botocore/data/m2/2021-04-28/service-2.json +++ b/botocore/data/m2/2021-04-28/service-2.json @@ -22,12 +22,12 @@ "input":{"shape":"CancelBatchJobExecutionRequest"}, "output":{"shape":"CancelBatchJobExecutionResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Cancels the running of a specific batch job execution.
" }, @@ -41,12 +41,12 @@ "input":{"shape":"CreateApplicationRequest"}, "output":{"shape":"CreateApplicationResponse"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Creates a new application with given parameters. Requires an existing runtime environment and application definition file.
", "idempotent":true @@ -61,13 +61,13 @@ "input":{"shape":"CreateDataSetImportTaskRequest"}, "output":{"shape":"CreateDataSetImportTaskResponse"}, "errors":[ - {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Starts a data set import task for a specific application.
", "idempotent":true @@ -82,13 +82,13 @@ "input":{"shape":"CreateDeploymentRequest"}, "output":{"shape":"CreateDeploymentResponse"}, "errors":[ - {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Creates and starts a deployment to deploy an application into a runtime environment.
", "idempotent":true @@ -103,12 +103,12 @@ "input":{"shape":"CreateEnvironmentRequest"}, "output":{"shape":"CreateEnvironmentResponse"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Creates a runtime environment for a given runtime engine.
", "idempotent":true @@ -123,11 +123,11 @@ "input":{"shape":"DeleteApplicationRequest"}, "output":{"shape":"DeleteApplicationResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Deletes a specific application. You cannot delete a running application.
", "idempotent":true @@ -142,12 +142,12 @@ "input":{"shape":"DeleteApplicationFromEnvironmentRequest"}, "output":{"shape":"DeleteApplicationFromEnvironmentResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Deletes a specific application from the specific runtime environment where it was previously deployed. You cannot delete a runtime environment using DeleteEnvironment if any application has ever been deployed to it. This API removes the association of the application with the runtime environment so you can delete the environment smoothly.
" }, @@ -161,11 +161,11 @@ "input":{"shape":"DeleteEnvironmentRequest"}, "output":{"shape":"DeleteEnvironmentResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Deletes a specific runtime environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment.
", "idempotent":true @@ -180,11 +180,11 @@ "input":{"shape":"GetApplicationRequest"}, "output":{"shape":"GetApplicationResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Describes the details of a specific application.
" }, @@ -198,11 +198,11 @@ "input":{"shape":"GetApplicationVersionRequest"}, "output":{"shape":"GetApplicationVersionResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Returns details about a specific version of a specific application.
" }, @@ -216,11 +216,11 @@ "input":{"shape":"GetBatchJobExecutionRequest"}, "output":{"shape":"GetBatchJobExecutionResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Gets the details of a specific batch job execution for a specific application.
" }, @@ -234,11 +234,11 @@ "input":{"shape":"GetDataSetDetailsRequest"}, "output":{"shape":"GetDataSetDetailsResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Gets the details of a specific data set.
" }, @@ -252,11 +252,11 @@ "input":{"shape":"GetDataSetImportTaskRequest"}, "output":{"shape":"GetDataSetImportTaskResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.
" }, @@ -270,11 +270,11 @@ "input":{"shape":"GetDeploymentRequest"}, "output":{"shape":"GetDeploymentResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Gets details of a specific deployment with a given deployment identifier.
" }, @@ -288,14 +288,29 @@ "input":{"shape":"GetEnvironmentRequest"}, "output":{"shape":"GetEnvironmentResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Describes a specific runtime environment.
" }, + "GetSignedBluinsightsUrl":{ + "name":"GetSignedBluinsightsUrl", + "http":{ + "method":"GET", + "requestUri":"/signed-bi-url", + "responseCode":200 + }, + "output":{"shape":"GetSignedBluinsightsUrlResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets a single sign-on URL that can be used to connect to AWS Blu Insights.
" + }, "ListApplicationVersions":{ "name":"ListApplicationVersions", "http":{ @@ -306,11 +321,11 @@ "input":{"shape":"ListApplicationVersionsRequest"}, "output":{"shape":"ListApplicationVersionsResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Returns a list of the application versions for a specific application.
" }, @@ -324,10 +339,10 @@ "input":{"shape":"ListApplicationsRequest"}, "output":{"shape":"ListApplicationsResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment.
" }, @@ -341,11 +356,11 @@ "input":{"shape":"ListBatchJobDefinitionsRequest"}, "output":{"shape":"ListBatchJobDefinitionsResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions in the list to start a batch job.
" }, @@ -359,11 +374,11 @@ "input":{"shape":"ListBatchJobExecutionsRequest"}, "output":{"shape":"ListBatchJobExecutionsResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Lists historical, current, and scheduled batch job executions for a specific application.
" }, @@ -377,11 +392,11 @@ "input":{"shape":"ListDataSetImportHistoryRequest"}, "output":{"shape":"ListDataSetImportHistoryResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Lists the data set imports for the specified application.
" }, @@ -395,11 +410,11 @@ "input":{"shape":"ListDataSetsRequest"}, "output":{"shape":"ListDataSetsResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on runtime environments. This is known as importing data sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask.
" }, @@ -413,11 +428,11 @@ "input":{"shape":"ListDeploymentsRequest"}, "output":{"shape":"ListDeploymentsResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that application. Each deployment is mapped to a particular application version.
" }, @@ -431,10 +446,10 @@ "input":{"shape":"ListEngineVersionsRequest"}, "output":{"shape":"ListEngineVersionsResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Lists the available engine versions.
" }, @@ -448,10 +463,10 @@ "input":{"shape":"ListEnvironmentsRequest"}, "output":{"shape":"ListEnvironmentsResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Lists the runtime environments.
" }, @@ -465,11 +480,11 @@ "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Lists the tags for the specified resource.
" }, @@ -483,12 +498,12 @@ "input":{"shape":"StartApplicationRequest"}, "output":{"shape":"StartApplicationResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Starts an application that is currently stopped.
" }, @@ -502,12 +517,12 @@ "input":{"shape":"StartBatchJobRequest"}, "output":{"shape":"StartBatchJobResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job.
" }, @@ -521,12 +536,12 @@ "input":{"shape":"StopApplicationRequest"}, "output":{"shape":"StopApplicationResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Stops a running application.
" }, @@ -540,12 +555,12 @@ "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ - {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Adds one or more tags to the specified resource.
" }, @@ -559,11 +574,11 @@ "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Removes one or more tags from the specified resource.
" }, @@ -577,12 +592,12 @@ "input":{"shape":"UpdateApplicationRequest"}, "output":{"shape":"UpdateApplicationResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Updates an application and creates a new version.
" }, @@ -596,13 +611,13 @@ "input":{"shape":"UpdateEnvironmentRequest"}, "output":{"shape":"UpdateEnvironmentResponse"}, "errors":[ - {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} ], "documentation":"Updates the configuration details for a specific runtime environment.
" } @@ -955,9 +970,7 @@ }, "CapacityValue":{ "type":"integer", - "box":true, - "max":100, - "min":1 + "box":true }, "ConflictException":{ "type":"structure", @@ -1015,7 +1028,7 @@ }, "roleArn":{ "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the role associated with the application.
" + "documentation":"The Amazon Resource Name (ARN) that identifies a role that the application uses to access Amazon Web Services resources that are not part of the application or are in a different Amazon Web Services account.
" }, "tags":{ "shape":"TagMap", @@ -1638,9 +1651,9 @@ "enum":[ "Creating", "Available", + "Updating", "Deleting", - "Failed", - "Updating" + "Failed" ] }, "EnvironmentSummary":{ @@ -2314,13 +2327,23 @@ } } }, + "GetSignedBluinsightsUrlResponse":{ + "type":"structure", + "required":["signedBiUrl"], + "members":{ + "signedBiUrl":{ + "shape":"String", + "documentation":"Single sign-on AWS Blu Insights URL.
" + } + } + }, "HighAvailabilityConfig":{ "type":"structure", "required":["desiredCapacity"], "members":{ "desiredCapacity":{ "shape":"CapacityValue", - "documentation":"The number of instances in a high availability configuration.
" + "documentation":"The number of instances in a high availability configuration. The minimum possible value is 1 and the maximum is 100.
" } }, "documentation":"Defines the details of a high availability configuration.
" @@ -2813,7 +2836,7 @@ "MaxResults":{ "type":"integer", "box":true, - "max":100, + "max":2000, "min":1 }, "NextToken":{ @@ -3298,7 +3321,7 @@ }, "desiredCapacity":{ "shape":"CapacityValue", - "documentation":"The desired capacity for the runtime environment to update.
" + "documentation":"The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.
" }, "engineVersion":{ "shape":"EngineVersion", diff --git a/botocore/data/snowball/2016-06-30/service-2.json b/botocore/data/snowball/2016-06-30/service-2.json index 7fe2406481..c64ba0e332 100644 --- a/botocore/data/snowball/2016-06-30/service-2.json +++ b/botocore/data/snowball/2016-06-30/service-2.json @@ -88,7 +88,7 @@ {"shape":"ClusterLimitExceededException"}, {"shape":"Ec2RequestFailedException"} ], - "documentation":"Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.
Only the Snowball; Edge device type is supported when ordering clustered jobs.
The device capacity is optional.
Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.
Snow Family devices and their capacities.
Device type: SNC1_SSD
Capacity: T14
Description: Snowcone
Device type: SNC1_HDD
Capacity: T8
Description: Snowcone
Device type: EDGE_S
Capacity: T98
Description: Snowball Edge Storage Optimized for data transfer only
Device type: EDGE_CG
Capacity: T42
Description: Snowball Edge Compute Optimized with GPU
Device type: EDGE_C
Capacity: T42
Description: Snowball Edge Compute Optimized without GPU
Device type: EDGE
Capacity: T100
Description: Snowball Edge Storage Optimized with EC2 Compute
Device type: STANDARD
Capacity: T50
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region
Device type: STANDARD
Capacity: T80
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
Device type: V3_5C
Capacity: T32
Description: Snowball Edge Compute Optimized without GPU
Device type: V3_5S
Capacity: T240
Description: Snowball Edge Storage Optimized 210TB
Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.
Only the Snowball; Edge device type is supported when ordering clustered jobs.
The device capacity is optional.
Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.
Snow Family devices and their capacities.
Device type: SNC1_SSD
Capacity: T14
Description: Snowcone
Device type: SNC1_HDD
Capacity: T8
Description: Snowcone
Device type: EDGE_S
Capacity: T98
Description: Snowball Edge Storage Optimized for data transfer only
Device type: EDGE_CG
Capacity: T42
Description: Snowball Edge Compute Optimized with GPU
Device type: EDGE_C
Capacity: T42
Description: Snowball Edge Compute Optimized without GPU
Device type: EDGE
Capacity: T100
Description: Snowball Edge Storage Optimized with EC2 Compute
This device is replaced with T98.
Device type: STANDARD
Capacity: T50
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region
Device type: STANDARD
Capacity: T80
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
Snow Family device type: RACK_5U_C
Capacity: T13
Description: Snowblade.
Device type: V3_5S
Capacity: T240
Description: Snowball Edge Storage Optimized 210TB
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
" + "documentation":"This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
" }, "ListJobs":{ "name":"ListJobs", @@ -308,6 +308,19 @@ ], "documentation":"Lists all long-term pricing types.
" }, + "ListPickupLocations":{ + "name":"ListPickupLocations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPickupLocationsRequest"}, + "output":{"shape":"ListPickupLocationsResult"}, + "errors":[ + {"shape":"InvalidResourceException"} + ], + "documentation":"A list of locations from which the customer can choose to pickup a device.
" + }, "ListServiceVersions":{ "name":"ListServiceVersions", "http":{ @@ -444,6 +457,10 @@ "IsRestricted":{ "shape":"Boolean", "documentation":"If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.
" + }, + "Type":{ + "shape":"AddressType", + "documentation":"Differentiates between delivery address and pickup address in the customer account. Provided at job creation.
" } }, "documentation":"The address that you want the Snow device(s) associated with a specific job to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. Although no individual elements of the Address are required, if the address is invalid or unsupported, then an exception is thrown.
List of jobs created for this cluster. For syntax, see ListJobsResult$JobListEntries in this guide.
" + "documentation":"List of jobs created for this cluster. For syntax, see ListJobsResult$JobListEntries in this guide.
" } } }, @@ -817,11 +841,19 @@ }, "RemoteManagement":{ "shape":"RemoteManagement", - "documentation":"Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.
Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Edge client to manage the device. When set to NOT_INSTALLED, remote management will not be available on the device.
The ID of the long-term pricing type for the device.
" + }, + "ImpactLevel":{ + "shape":"ImpactLevel", + "documentation":"The highest impact level of data that will be stored or processed on the device, provided at job creation.
" + }, + "PickupDetails":{ + "shape":"PickupDetails", + "documentation":"Information identifying the person picking up the device.
" } } }, @@ -836,7 +868,10 @@ }, "CreateLongTermPricingRequest":{ "type":"structure", - "required":["LongTermPricingType"], + "required":[ + "LongTermPricingType", + "SnowballType" + ], "members":{ "LongTermPricingType":{ "shape":"LongTermPricingType", @@ -1048,6 +1083,12 @@ }, "documentation":"The container for SnowconeDeviceConfiguration.
The ID of the AMI on the Snow device.
" } }, - "documentation":"A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), including the Amazon EC2 AMI ID and the Snow device AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the Amazon Web Services Cloud and on the device.
" + "documentation":"A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), including the Amazon EC2-compatible AMI ID and the Snow device AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the Amazon Web Services Cloud and on the device.
" }, "Ec2AmiResourceList":{ "type":"list", @@ -1096,6 +1137,13 @@ "documentation":"Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
", "exception":true }, + "Email":{ + "type":"string", + "max":320, + "min":3, + "pattern":"^(?=.{3,100}$).+@.+[.].+$", + "sensitive":true + }, "EventTriggerDefinition":{ "type":"structure", "members":{ @@ -1201,6 +1249,16 @@ }, "documentation":"The tax documents required in Amazon Web Services Region in India.
" }, + "ImpactLevel":{ + "type":"string", + "enum":[ + "IL2", + "IL4", + "IL5", + "IL6", + "IL99" + ] + }, "InitialClusterSize":{ "type":"integer", "max":16, @@ -1401,6 +1459,18 @@ "OnDeviceServiceConfiguration":{ "shape":"OnDeviceServiceConfiguration", "documentation":"Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
" + }, + "ImpactLevel":{ + "shape":"ImpactLevel", + "documentation":"The highest impact level of data that will be stored or processed on the device, provided at job creation.
" + }, + "PickupDetails":{ + "shape":"PickupDetails", + "documentation":"Information identifying the person picking up the device.
" + }, + "SnowballId":{ + "shape":"String", + "documentation":"Unique ID associated with a device.
" } }, "documentation":"Contains information about a specific job including shipping information, job status, and other important metadata. This information is returned as a part of the response syntax of the DescribeJob action.
The maximum number of locations to list per page.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"HTTP requests are stateless. To identify what object comes \"next\" in the list of ListPickupLocationsRequest objects, you have the option of specifying NextToken as the starting point for your returned list.
Information about the address of pickup locations.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"HTTP requests are stateless. To identify what object comes \"next\" in the list of ListPickupLocationsResult objects, you have the option of specifying NextToken as the starting point for your returned list.
Any change in job state will trigger a notification for this job.
" + }, + "DevicePickupSnsTopicARN":{ + "shape":"SnsTopicARN", + "documentation":"Used to send SNS notifications for the person picking up the device (identified during job creation).
" } }, "documentation":"The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.
When the notification settings are defined during job creation, you can choose to notify based on a specific set of job states using the JobStatesToNotify array of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states with NotifyAll set to true.
An object that represents the metadata and configuration settings for services on an Amazon Web Services Snow Family device.
" }, + "PhoneNumber":{ + "type":"string", + "max":30, + "min":7, + "pattern":"^\\s*(?:\\+?(\\d{1,3}))?[-. (]*(\\d{3})[-. )]*(\\d{3})[-. ]*(\\d{4})(?: *x(\\d+))?\\s*$", + "sensitive":true + }, + "PickupDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the person picking up the device.
" + }, + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The phone number of the person picking up the device.
" + }, + "Email":{ + "shape":"Email", + "documentation":"The email address of the person picking up the device.
" + }, + "IdentificationNumber":{ + "shape":"String", + "documentation":"The number on the credential identifying the person picking up the device.
" + }, + "IdentificationExpirationDate":{ + "shape":"Timestamp", + "documentation":"Expiration date of the credential identifying the person picking up the device.
" + }, + "IdentificationIssuingOrg":{ + "shape":"String", + "documentation":"Organization that issued the credential identifying the person picking up the device.
" + }, + "DevicePickupId":{ + "shape":"DevicePickupId", + "documentation":"The unique ID for a device that will be picked up.
" + } + }, + "documentation":"Information identifying the person picking up the device.
" + }, "RemoteManagement":{ "type":"string", "enum":[ "INSTALLED_ONLY", - "INSTALLED_AUTOSTART" + "INSTALLED_AUTOSTART", + "NOT_INSTALLED" ] }, "ResourceARN":{ @@ -1989,7 +2131,8 @@ "T14", "T32", "NoPreference", - "T240" + "T240", + "T13" ] }, "SnowballType":{ @@ -2003,7 +2146,8 @@ "SNC1_HDD", "SNC1_SSD", "V3_5C", - "V3_5S" + "V3_5S", + "RACK_5U_C" ] }, "SnowconeDeviceConfiguration":{ @@ -2181,7 +2325,8 @@ "ForwardingAddressId":{ "shape":"AddressId", "documentation":"The updated ID for the forwarding address for a job. This field is not supported in most regions.
" - } + }, + "PickupDetails":{"shape":"PickupDetails"} } }, "UpdateJobResult":{ diff --git a/botocore/data/translate/2017-07-01/service-2.json b/botocore/data/translate/2017-07-01/service-2.json index 68fa90d5c4..15562fc7a8 100644 --- a/botocore/data/translate/2017-07-01/service-2.json +++ b/botocore/data/translate/2017-07-01/service-2.json @@ -533,7 +533,7 @@ }, "ContentType":{ "shape":"ContentType", - "documentation":"Describes the format of the document. You can specify one of the following:
text/html - The input data consists of HTML content. Amazon Translate translates only the text in the HTML element.
text/plain - The input data consists of unformatted text. Amazon Translate translates every character in the content.
Describes the format of the document. You can specify one of the following:
text/html - The input data consists of HTML content. Amazon Translate translates only the text in the HTML element.
text/plain - The input data consists of unformatted text. Amazon Translate translates every character in the content.
application/vnd.openxmlformats-officedocument.wordprocessingml.document - The input data consists of a Word document (.docx).
The content and content type of a document.
"