updateKxEnvironment method
Updates information for the given kdb environment.
May throw AccessDeniedException.
May throw ConflictException.
May throw InternalServerException.
May throw ResourceNotFoundException.
May throw ThrottlingException.
May throw ValidationException.
Parameter environmentId :
A unique identifier for the kdb environment.
Parameter clientToken :
A token that ensures idempotency. This token expires in 10 minutes.
Parameter description :
A description of the kdb environment.
Parameter name :
The name of the kdb environment.
Implementation
Future<UpdateKxEnvironmentResponse> updateKxEnvironment({
required String environmentId,
String? clientToken,
String? description,
String? name,
}) async {
final $payload = <String, dynamic>{
'clientToken': clientToken ?? _s.generateIdempotencyToken(),
if (description != null) 'description': description,
if (name != null) 'name': name,
};
final response = await _protocol.send(
payload: $payload,
method: 'PUT',
requestUri: '/kx/environments/${Uri.encodeComponent(environmentId)}',
exceptionFnMap: _exceptionFns,
);
return UpdateKxEnvironmentResponse.fromJson(response);
}