Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

AssociateBot

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.

Request Syntax


PUT /instance/InstanceId/bot HTTP/1.1
Content-type: application/json

{
   "LexBot": { 
      "LexRegion": "string",
      "Name": "string"
   },
   "LexV2Bot": { 
      "AliasArn": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

LexBot

Configuration information of an Amazon Lex bot.

Type: LexBot object

Required: No

LexV2Bot

The Amazon Lex V2 bot to associate with the instance.

Type: LexV2Bot object

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

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

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

LimitExceededException

The allowed limit for the resource has been exceeded.

HTTP Status Code: 429

ResourceConflictException

A resource already has that name.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ServiceQuotaExceededException

The service quota has been exceeded.

HTTP Status Code: 402

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429