updateGroup method

Future<UpdateGroupResponse> updateGroup({ required String awsAccountId, required String groupName, required String namespace, String? description, })

Changes a group description.

May throw AccessDeniedException. May throw InvalidParameterValueException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw PreconditionNotMetException. May throw InternalFailureException. May throw ResourceUnavailableException.

Parameter awsAccountId : The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Parameter groupName : The name of the group that you want to update.

Parameter namespace : The namespace. Currently, you should set this to default.

Parameter description : The description for the group that you want to update.

Implementation

Future<UpdateGroupResponse> updateGroup({
  required String awsAccountId,
  required String groupName,
  required String namespace,
  String? description,
}) async {
  ArgumentError.checkNotNull(awsAccountId, 'awsAccountId');
  _s.validateStringLength(
    'awsAccountId',
    awsAccountId,
    12,
    12,
    isRequired: true,
  );
  ArgumentError.checkNotNull(groupName, 'groupName');
  _s.validateStringLength(
    'groupName',
    groupName,
    1,
    1152921504606846976,
    isRequired: true,
  );
  ArgumentError.checkNotNull(namespace, 'namespace');
  _s.validateStringLength(
    'namespace',
    namespace,
    0,
    64,
    isRequired: true,
  );
  _s.validateStringLength(
    'description',
    description,
    1,
    512,
  );
  final $payload = <String, dynamic>{
    if (description != null) 'Description': description,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PUT',
    requestUri:
        '/accounts/${Uri.encodeComponent(awsAccountId)}/namespaces/${Uri.encodeComponent(namespace)}/groups/${Uri.encodeComponent(groupName)}',
    exceptionFnMap: _exceptionFns,
  );
  return UpdateGroupResponse.fromJson(response);
}