createCustomDataIdentifier method

Future<CreateCustomDataIdentifierResponse> createCustomDataIdentifier({ required String name, required String regex, String? clientToken, String? description, List<String>? ignoreWords, List<String>? keywords, int? maximumMatchDistance, List<SeverityLevel>? severityLevels, Map<String, String>? tags, })

Creates and defines the criteria and other settings for a custom data identifier.

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

Parameter name : A custom name for the custom data identifier. The name can contain as many as 128 characters.

We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.

Parameter regex : The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

Parameter clientToken : A unique, case-sensitive token that you provide to ensure the idempotency of the request.

Parameter description : A custom description of the custom data identifier. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see this description, depending on the actions that they're allowed to perform in Amazon Macie.

Parameter ignoreWords : An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

Parameter keywords : An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

Parameter maximumMatchDistance : The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.

Parameter severityLevels : The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that match the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding.

If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

Parameter tags : A map of key-value pairs that specifies the tags to associate with the custom data identifier.

A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Implementation

Future<CreateCustomDataIdentifierResponse> createCustomDataIdentifier({
  required String name,
  required String regex,
  String? clientToken,
  String? description,
  List<String>? ignoreWords,
  List<String>? keywords,
  int? maximumMatchDistance,
  List<SeverityLevel>? severityLevels,
  Map<String, String>? tags,
}) async {
  final $payload = <String, dynamic>{
    'name': name,
    'regex': regex,
    'clientToken': clientToken ?? _s.generateIdempotencyToken(),
    if (description != null) 'description': description,
    if (ignoreWords != null) 'ignoreWords': ignoreWords,
    if (keywords != null) 'keywords': keywords,
    if (maximumMatchDistance != null)
      'maximumMatchDistance': maximumMatchDistance,
    if (severityLevels != null) 'severityLevels': severityLevels,
    if (tags != null) 'tags': tags,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/custom-data-identifiers',
    exceptionFnMap: _exceptionFns,
  );
  return CreateCustomDataIdentifierResponse.fromJson(response);
}