updateIndex method
Updates an Amazon Q Business index.
May throw AccessDeniedException.
May throw ConflictException.
May throw InternalServerException.
May throw ResourceNotFoundException.
May throw ServiceQuotaExceededException.
May throw ThrottlingException.
May throw ValidationException.
Parameter applicationId :
The identifier of the Amazon Q Business application connected to the
index.
Parameter indexId :
The identifier of the Amazon Q Business index.
Parameter capacityConfiguration :
The storage capacity units you want to provision for your Amazon Q
Business index. You can add and remove capacity to fit your usage needs.
Parameter description :
The description of the Amazon Q Business index.
Parameter displayName :
The name of the Amazon Q Business index.
Parameter documentAttributeConfigurations :
Configuration information for document metadata or fields. Document
metadata are fields or attributes associated with your documents. For
example, the company department name associated with each document. For
more information, see Understanding
document attributes.
Implementation
Future<void> updateIndex({
required String applicationId,
required String indexId,
IndexCapacityConfiguration? capacityConfiguration,
String? description,
String? displayName,
List<DocumentAttributeConfiguration>? documentAttributeConfigurations,
}) async {
final $payload = <String, dynamic>{
if (capacityConfiguration != null)
'capacityConfiguration': capacityConfiguration,
if (description != null) 'description': description,
if (displayName != null) 'displayName': displayName,
if (documentAttributeConfigurations != null)
'documentAttributeConfigurations': documentAttributeConfigurations,
};
final response = await _protocol.send(
payload: $payload,
method: 'PUT',
requestUri:
'/applications/${Uri.encodeComponent(applicationId)}/indices/${Uri.encodeComponent(indexId)}',
exceptionFnMap: _exceptionFns,
);
}