updateEnvironment method

Future<UpdateEnvironmentResponse> updateEnvironment({ required String environmentId, String? description, FederationMode? federationMode, FederationParameters? federationParameters, String? name, })

Update your FinSpace environment.

May throw AccessDeniedException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter environmentId : The identifier of the FinSpace environment.

Parameter description : The description of the environment.

Parameter federationMode : Authentication mode for the environment.

• FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
• LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

Parameter name : The name of the environment.

Implementation

Future<UpdateEnvironmentResponse> updateEnvironment({
  required String environmentId,
  String? description,
  FederationMode? federationMode,
  FederationParameters? federationParameters,
  String? name,
}) async {
  final $payload = <String, dynamic>{
    if (description != null) 'description': description,
    if (federationMode != null) 'federationMode': federationMode.value,
    if (federationParameters != null)
      'federationParameters': federationParameters,
    if (name != null) 'name': name,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PUT',
    requestUri: '/environment/${Uri.encodeComponent(environmentId)}',
    exceptionFnMap: _exceptionFns,
  );
  return UpdateEnvironmentResponse.fromJson(response);
}