UpdateDataAccessor
Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.
Request Syntax
PUT /applications/applicationId
/dataaccessors/dataAccessorId
HTTP/1.1
Content-type: application/json
{
"actionConfigurations": [
{
"action": "string
",
"filterConfiguration": {
"documentAttributeFilter": {
"andAllFilters": [
"AttributeFilter"
],
"containsAll": {
"name": "string
",
"value": { ... }
},
"containsAny": {
"name": "string
",
"value": { ... }
},
"equalsTo": {
"name": "string
",
"value": { ... }
},
"greaterThan": {
"name": "string
",
"value": { ... }
},
"greaterThanOrEquals": {
"name": "string
",
"value": { ... }
},
"lessThan": {
"name": "string
",
"value": { ... }
},
"lessThanOrEquals": {
"name": "string
",
"value": { ... }
},
"notFilter": "AttributeFilter",
"orAllFilters": [
"AttributeFilter"
]
}
}
}
],
"displayName": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The unique identifier of the Amazon Q Business application.
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]{35}
Required: Yes
- dataAccessorId
-
The unique identifier of the data accessor to update.
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]{35}
Required: Yes
Request Body
The request accepts the following data in JSON format.
- actionConfigurations
-
The updated list of action configurations specifying the allowed actions and any associated filters.
Type: Array of ActionConfiguration objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
- displayName
-
The updated friendly name for the data accessor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]*
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.
- AccessDeniedException
-
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
HTTP Status Code: 403
- ConflictException
-
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
HTTP Status Code: 409
- InternalServerException
-
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support
for help. HTTP Status Code: 500
- ResourceNotFoundException
-
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to throttling. Reduce the number of requests and try again.
HTTP Status Code: 429
- ValidationException
-
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try 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: