AWS SDK Version 3 for .NET
API Reference

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

This is the response object from the GetBot operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.LexModelBuildingService.Model.GetBotResponse

Namespace: Amazon.LexModelBuildingService.Model
Assembly: AWSSDK.LexModelBuildingService.dll
Version: 3.x.y.z

Syntax

C#
public class GetBotResponse : AmazonWebServiceResponse

The GetBotResponse type exposes the following members

Constructors

NameDescription
Public Method GetBotResponse()

Properties

NameTypeDescription
Public Property AbortStatement Amazon.LexModelBuildingService.Model.Statement

Gets and sets the property AbortStatement.

The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.

Public Property Checksum System.String

Gets and sets the property Checksum.

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

Public Property ChildDirected System.Boolean

Gets and sets the property ChildDirected.

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex 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 the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex 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. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not 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. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex 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.

If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

Public Property ClarificationPrompt Amazon.LexModelBuildingService.Model.Prompt

Gets and sets the property ClarificationPrompt.

The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreatedDate System.DateTime

Gets and sets the property CreatedDate.

The date that the bot was created.

Public Property Description System.String

Gets and sets the property Description.

A description of the bot.

Public Property FailureReason System.String

Gets and sets the property FailureReason.

If status is FAILED, Amazon Lex explains why it failed to build the bot.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property IdleSessionTTLInSeconds System.Int32

Gets and sets the property IdleSessionTTLInSeconds.

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

Public Property Intents System.Collections.Generic.List<Amazon.LexModelBuildingService.Model.Intent>

Gets and sets the property Intents.

An array of intent objects. For more information, see PutBot.

Public Property LastUpdatedDate System.DateTime

Gets and sets the property LastUpdatedDate.

The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

Public Property Locale Amazon.LexModelBuildingService.Locale

Gets and sets the property Locale.

The target locale for the bot.

Public Property Name System.String

Gets and sets the property Name.

The name of the bot.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Status Amazon.LexModelBuildingService.Status

Gets and sets the property Status.

The status of the bot. If the bot is ready to run, the status is READY. If there was a problem with building the bot, the status is FAILED and the failureReason explains why the bot did not build. If the bot was saved but not built, the status is NOT BUILT.

Public Property Version System.String

Gets and sets the property Version.

The version of the bot. For a new bot, the version is always $LATEST.

Public Property VoiceId System.String

Gets and sets the property VoiceId.

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

Examples

This example shows how to get configuration information for a bot.

To get information about a bot


var response = client.GetBot(new GetBotRequest 
{
    Name = "DocOrderPizza",
    VersionOrAlias = "$LATEST"
});

string version = response.Version;
string name = response.Name;
Statement abortStatement = response.AbortStatement;
string checksum = response.Checksum;
bool childDirected = response.ChildDirected;
Prompt clarificationPrompt = response.ClarificationPrompt;
DateTime createdDate = response.CreatedDate;
string description = response.Description;
integer idleSessionTTLInSeconds = response.IdleSessionTTLInSeconds;
List intents = response.Intents;
DateTime lastUpdatedDate = response.LastUpdatedDate;
string locale = response.Locale;
string status = response.Status;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms