# DescribeBot


Provides metadata information about a bot. 

## Request Syntax


```
GET /bots/botId/ HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [botId](#API_DescribeBot_RequestSyntax) **   <a name="lexv2-DescribeBot-request-uri-botId"></a>
The unique identifier of the bot to describe.  
Length Constraints: Fixed length of 10.  
Pattern: `^[0-9a-zA-Z]+$`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "botId": "string",
   "botMembers": [ 
      { 
         "botMemberAliasId": "string",
         "botMemberAliasName": "string",
         "botMemberId": "string",
         "botMemberName": "string",
         "botMemberVersion": "string"
      }
   ],
   "botName": "string",
   "botStatus": "string",
   "botType": "string",
   "creationDateTime": number,
   "dataPrivacy": { 
      "childDirected": boolean
   },
   "description": "string",
   "errorLogSettings": { 
      "enabled": boolean
   },
   "failureReasons": [ "string" ],
   "idleSessionTTLInSeconds": number,
   "lastUpdatedDateTime": number,
   "roleArn": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [botId](#API_DescribeBot_ResponseSyntax) **   <a name="lexv2-DescribeBot-response-botId"></a>
The unique identifier of the bot.  
Type: String  
Length Constraints: Fixed length of 10.  
Pattern: `^[0-9a-zA-Z]+$` 

 ** [botMembers](#API_DescribeBot_ResponseSyntax) **   <a name="lexv2-DescribeBot-response-botMembers"></a>
The list of bots in the network that was described.  
Type: Array of [BotMember](API_BotMember.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [botName](#API_DescribeBot_ResponseSyntax) **   <a name="lexv2-DescribeBot-response-botName"></a>
The name of the bot.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$` 

 ** [botStatus](#API_DescribeBot_ResponseSyntax) **   <a name="lexv2-DescribeBot-response-botStatus"></a>
The current status of the bot. When the status is `Available` the bot is ready to be used in conversations with users.  
Type: String  
Valid Values: `Creating | Available | Inactive | Deleting | Failed | Versioning | Importing | Updating` 

 ** [botType](#API_DescribeBot_ResponseSyntax) **   <a name="lexv2-DescribeBot-response-botType"></a>
The type of the bot that was described.  
Type: String  
Valid Values: `Bot | BotNetwork` 

 ** [creationDateTime](#API_DescribeBot_ResponseSyntax) **   <a name="lexv2-DescribeBot-response-creationDateTime"></a>
A timestamp of the date and time that the bot was created.  
Type: Timestamp

 ** [dataPrivacy](#API_DescribeBot_ResponseSyntax) **   <a name="lexv2-DescribeBot-response-dataPrivacy"></a>
Settings for managing data privacy of the bot and its conversations with users.  
Type: [DataPrivacy](API_DataPrivacy.md) object

 ** [description](#API_DescribeBot_ResponseSyntax) **   <a name="lexv2-DescribeBot-response-description"></a>
The description of the bot.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.

 ** [errorLogSettings](#API_DescribeBot_ResponseSyntax) **   <a name="lexv2-DescribeBot-response-errorLogSettings"></a>
Contains the configuration for error logging that specifies where and how bot errors are recorded, including destinations like CloudWatch Logs.  
Type: [ErrorLogSettings](API_ErrorLogSettings.md) object

 ** [failureReasons](#API_DescribeBot_ResponseSyntax) **   <a name="lexv2-DescribeBot-response-failureReasons"></a>
If the `botStatus` is `Failed`, this contains a list of reasons that the bot couldn't be built.  
Type: Array of strings

 ** [idleSessionTTLInSeconds](#API_DescribeBot_ResponseSyntax) **   <a name="lexv2-DescribeBot-response-idleSessionTTLInSeconds"></a>
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.  
Type: Integer  
Valid Range: Minimum value of 60. Maximum value of 86400.

 ** [lastUpdatedDateTime](#API_DescribeBot_ResponseSyntax) **   <a name="lexv2-DescribeBot-response-lastUpdatedDateTime"></a>
A timestamp of the date and time that the bot was last updated.  
Type: Timestamp

 ** [roleArn](#API_DescribeBot_ResponseSyntax) **   <a name="lexv2-DescribeBot-response-roleArn"></a>
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 2048.  
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The service encountered an unexpected condition. Try your request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have reached a quota for your bot.   
HTTP Status Code: 402

 ** ThrottlingException **   
Your request rate is too high. Reduce the frequency of requests.    
 ** retryAfterSeconds **   
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429

 ** ValidationException **   
One of the input parameters in your request isn't valid. Check the parameters and try your request again.  
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/models.lex.v2-2020-08-07/DescribeBot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeBot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeBot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeBot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeBot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeBot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeBot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeBot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeBot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeBot)