updateGroup method

Future<UpdateGroupResult> updateGroup({
  1. String? filterExpression,
  2. String? groupARN,
  3. String? groupName,
  4. InsightsConfiguration? insightsConfiguration,
})

Updates a group resource.

May throw InvalidRequestException. May throw ThrottledException.

Parameter filterExpression : The updated filter expression defining criteria by which to group traces.

Parameter groupARN : The ARN that was generated upon creation.

Parameter groupName : The case-sensitive name of the group.

Parameter insightsConfiguration : The structure containing configurations related to insights.

  • The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
  • The NotifcationsEnabled boolean can be set to true to enable insights notifications for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.

Implementation

Future<UpdateGroupResult> updateGroup({
  String? filterExpression,
  String? groupARN,
  String? groupName,
  InsightsConfiguration? insightsConfiguration,
}) async {
  _s.validateStringLength(
    'groupARN',
    groupARN,
    1,
    400,
  );
  _s.validateStringLength(
    'groupName',
    groupName,
    1,
    32,
  );
  final $payload = <String, dynamic>{
    if (filterExpression != null) 'FilterExpression': filterExpression,
    if (groupARN != null) 'GroupARN': groupARN,
    if (groupName != null) 'GroupName': groupName,
    if (insightsConfiguration != null)
      'InsightsConfiguration': insightsConfiguration,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/UpdateGroup',
    exceptionFnMap: _exceptionFns,
  );
  return UpdateGroupResult.fromJson(response);
}