UpdateChimeWebhookConfiguration
Updates a Amazon Chime webhook configuration.
Request Syntax
POST /update-chime-webhook-configuration HTTP/1.1
Content-type: application/json
{
"ChatConfigurationArn": "string",
"IamRoleArn": "string",
"LoggingLevel": "string",
"SnsTopicArns": [ "string" ],
"WebhookDescription": "string",
"WebhookUrl": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ChatConfigurationArn
-
The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to update.
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
- IamRoleArn
-
A user-defined role that Amazon Q Developer assumes. This is not the service-linked role.
For more information, see IAM policies for Amazon Q Developer in chat applications in the Amazon Q Developer Administrator Guide.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 1224.
Pattern:
arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}Required: No
- LoggingLevel
-
Logging levels include
ERROR,INFO, orNONE.Type: String
Length Constraints: Minimum length of 4. Maximum length of 5.
Pattern:
(ERROR|INFO|NONE)Required: No
- SnsTopicArns
-
The ARNs of the SNS topics that deliver notifications to Amazon Q Developer.
Type: Array of strings
Length Constraints: Minimum length of 12. Maximum length of 1224.
Pattern:
arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}Required: No
- WebhookDescription
-
A description of the webhook. We recommend using the convention
RoomName/WebhookName.For more information, see Tutorial: Get started with Amazon Chime in the Amazon Q Developer Administrator Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- WebhookUrl
-
The URL for the Amazon Chime webhook.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
https://hooks\.chime\.aws/incomingwebhooks/[A-Za-z0-9\-]+?\?token=[A-Za-z0-9\-]+Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"WebhookConfiguration": {
"ChatConfigurationArn": "string",
"ConfigurationName": "string",
"IamRoleArn": "string",
"LoggingLevel": "string",
"SnsTopicArns": [ "string" ],
"State": "string",
"StateReason": "string",
"Tags": [
{
"TagKey": "string",
"TagValue": "string"
}
],
"WebhookDescription": "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.
- WebhookConfiguration
-
A Amazon Chime webhook configuration.
Type: ChimeWebhookConfiguration object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterException
-
Your request input doesn't meet the constraints required by Amazon Q Developer.
HTTP Status Code: 400
- InvalidRequestException
-
Your request input doesn't meet the constraints required by Amazon Q Developer.
HTTP Status Code: 400
- ResourceNotFoundException
-
We were unable to find the resource for your request
HTTP Status Code: 404
- UpdateChimeWebhookConfigurationException
-
We can’t process your request right now because of a server issue. Try again later.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
