@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
142 lines (141 loc) • 4.31 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides details about a specific Amazon Lex Bot.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const orderFlowersBot = aws.lex.getBot({
* name: "OrderFlowers",
* version: "$LATEST",
* });
* ```
*/
export declare function getBot(args: GetBotArgs, opts?: pulumi.InvokeOptions): Promise<GetBotResult>;
/**
* A collection of arguments for invoking getBot.
*/
export interface GetBotArgs {
/**
* Name of the bot. The name is case sensitive.
*/
name: string;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: string;
/**
* Version or alias of the bot.
*/
version?: string;
}
/**
* A collection of values returned by getBot.
*/
export interface GetBotResult {
/**
* ARN of the bot.
*/
readonly arn: string;
/**
* Checksum of the bot used to identify a specific revision of the bot's `$LATEST` version.
*/
readonly checksum: string;
/**
* If this Amazon Lex Bot is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.
*/
readonly childDirected: boolean;
/**
* Date that the bot was created.
*/
readonly createdDate: string;
/**
* Description of the bot.
*/
readonly description: string;
/**
* When set to true user utterances are sent to Amazon Comprehend for sentiment analysis.
*/
readonly detectSentiment: boolean;
/**
* Set to true if natural language understanding improvements are enabled.
*/
readonly enableModelImprovements: boolean;
/**
* If the `status` is `FAILED`, the reason why the bot failed to build.
*/
readonly failureReason: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
*/
readonly idleSessionTtlInSeconds: number;
/**
* Date that the bot was updated.
*/
readonly lastUpdatedDate: string;
/**
* Target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.
*/
readonly locale: string;
/**
* Name of the bot, case sensitive.
*/
readonly name: string;
/**
* The threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.
*/
readonly nluIntentConfidenceThreshold: number;
readonly region: string;
/**
* Status of the bot.
*/
readonly status: string;
/**
* Version of the bot. For a new bot, the version is always `$LATEST`.
*/
readonly version?: string;
/**
* Amazon Polly voice ID that the Amazon Lex Bot uses for voice interactions with the user.
*/
readonly voiceId: string;
}
/**
* Provides details about a specific Amazon Lex Bot.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const orderFlowersBot = aws.lex.getBot({
* name: "OrderFlowers",
* version: "$LATEST",
* });
* ```
*/
export declare function getBotOutput(args: GetBotOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetBotResult>;
/**
* A collection of arguments for invoking getBot.
*/
export interface GetBotOutputArgs {
/**
* Name of the bot. The name is case sensitive.
*/
name: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Version or alias of the bot.
*/
version?: pulumi.Input<string>;
}