AssociateToConfiguration - Amazon Q Developer in chat applications

AssociateToConfiguration

Links a resource (for example, a custom action) to a channel configuration.

Request Syntax

POST /associate-to-configuration HTTP/1.1 Content-type: application/json { "ChatConfiguration": "string", "Resource": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ChatConfiguration

The channel configuration to associate with the resource.

Type: String

Length Constraints: Minimum length of 19. Maximum length of 1169.

Pattern: arn:aws:(wheatley|chatbot):[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}

Required: Yes

Resource

The resource Amazon Resource Name (ARN) to link.

Type: String

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

Pattern: arn:aws:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:custom-action/[a-zA-Z0-9_-]{1,64}

Required: Yes

Response Syntax

HTTP/1.1 201

Response Elements

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

Errors

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

InternalServiceError

Unexpected error during processing of request.

HTTP Status Code: 500

InvalidRequestException

Your request input doesn't meet the constraints required by Amazon Q Developer.

HTTP Status Code: 400

UnauthorizedException

The request was rejected because it doesn't have valid credentials for the target resource.

HTTP Status Code: 403

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: