Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Retrieves the criteria and other settings for a custom data identifier.
Synopsis
- data GetCustomDataIdentifier = GetCustomDataIdentifier' {}
- newGetCustomDataIdentifier :: Text -> GetCustomDataIdentifier
- getCustomDataIdentifier_id :: Lens' GetCustomDataIdentifier Text
- data GetCustomDataIdentifierResponse = GetCustomDataIdentifierResponse' {
- arn :: Maybe Text
- createdAt :: Maybe ISO8601
- deleted :: Maybe Bool
- description :: Maybe Text
- id :: Maybe Text
- ignoreWords :: Maybe [Text]
- keywords :: Maybe [Text]
- maximumMatchDistance :: Maybe Int
- name :: Maybe Text
- regex :: Maybe Text
- severityLevels :: Maybe [SeverityLevel]
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- newGetCustomDataIdentifierResponse :: Int -> GetCustomDataIdentifierResponse
- getCustomDataIdentifierResponse_arn :: Lens' GetCustomDataIdentifierResponse (Maybe Text)
- getCustomDataIdentifierResponse_createdAt :: Lens' GetCustomDataIdentifierResponse (Maybe UTCTime)
- getCustomDataIdentifierResponse_deleted :: Lens' GetCustomDataIdentifierResponse (Maybe Bool)
- getCustomDataIdentifierResponse_description :: Lens' GetCustomDataIdentifierResponse (Maybe Text)
- getCustomDataIdentifierResponse_id :: Lens' GetCustomDataIdentifierResponse (Maybe Text)
- getCustomDataIdentifierResponse_ignoreWords :: Lens' GetCustomDataIdentifierResponse (Maybe [Text])
- getCustomDataIdentifierResponse_keywords :: Lens' GetCustomDataIdentifierResponse (Maybe [Text])
- getCustomDataIdentifierResponse_maximumMatchDistance :: Lens' GetCustomDataIdentifierResponse (Maybe Int)
- getCustomDataIdentifierResponse_name :: Lens' GetCustomDataIdentifierResponse (Maybe Text)
- getCustomDataIdentifierResponse_regex :: Lens' GetCustomDataIdentifierResponse (Maybe Text)
- getCustomDataIdentifierResponse_severityLevels :: Lens' GetCustomDataIdentifierResponse (Maybe [SeverityLevel])
- getCustomDataIdentifierResponse_tags :: Lens' GetCustomDataIdentifierResponse (Maybe (HashMap Text Text))
- getCustomDataIdentifierResponse_httpStatus :: Lens' GetCustomDataIdentifierResponse Int
Creating a Request
data GetCustomDataIdentifier Source #
See: newGetCustomDataIdentifier
smart constructor.
Instances
newGetCustomDataIdentifier Source #
Create a value of GetCustomDataIdentifier
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetCustomDataIdentifier
, getCustomDataIdentifier_id
- The unique identifier for the Amazon Macie resource that the request
applies to.
Request Lenses
getCustomDataIdentifier_id :: Lens' GetCustomDataIdentifier Text Source #
The unique identifier for the Amazon Macie resource that the request applies to.
Destructuring the Response
data GetCustomDataIdentifierResponse Source #
See: newGetCustomDataIdentifierResponse
smart constructor.
GetCustomDataIdentifierResponse' | |
|
Instances
newGetCustomDataIdentifierResponse Source #
Create a value of GetCustomDataIdentifierResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetCustomDataIdentifierResponse
, getCustomDataIdentifierResponse_arn
- The Amazon Resource Name (ARN) of the custom data identifier.
GetCustomDataIdentifierResponse
, getCustomDataIdentifierResponse_createdAt
- The date and time, in UTC and extended ISO 8601 format, when the custom
data identifier was created.
GetCustomDataIdentifierResponse
, getCustomDataIdentifierResponse_deleted
- Specifies whether the custom data identifier was deleted. If you delete
a custom data identifier, Amazon Macie doesn't delete it permanently.
Instead, it soft deletes the identifier.
GetCustomDataIdentifierResponse
, getCustomDataIdentifierResponse_description
- The custom description of the custom data identifier.
GetCustomDataIdentifier
, getCustomDataIdentifierResponse_id
- The unique identifier for the custom data identifier.
$sel:ignoreWords:GetCustomDataIdentifierResponse'
, getCustomDataIdentifierResponse_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. Ignore words
are case sensitive.
$sel:keywords:GetCustomDataIdentifierResponse'
, getCustomDataIdentifierResponse_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. Keywords aren't case sensitive.
$sel:maximumMatchDistance:GetCustomDataIdentifierResponse'
, getCustomDataIdentifierResponse_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.
Otherwise, Macie excludes the result.
GetCustomDataIdentifierResponse
, getCustomDataIdentifierResponse_name
- The custom name of the custom data identifier.
GetCustomDataIdentifierResponse
, getCustomDataIdentifierResponse_regex
- The regular expression (regex) that defines the pattern to match.
$sel:severityLevels:GetCustomDataIdentifierResponse'
, getCustomDataIdentifierResponse_severityLevels
- Specifies the severity that's assigned to findings that the custom data
identifier produces, based on the number of occurrences of text that
matches the custom data identifier's detection criteria. By default,
Amazon 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.
GetCustomDataIdentifierResponse
, getCustomDataIdentifierResponse_tags
- A map of key-value pairs that identifies the tags (keys and values) that
are associated with the custom data identifier.
$sel:httpStatus:GetCustomDataIdentifierResponse'
, getCustomDataIdentifierResponse_httpStatus
- The response's http status code.
Response Lenses
getCustomDataIdentifierResponse_arn :: Lens' GetCustomDataIdentifierResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the custom data identifier.
getCustomDataIdentifierResponse_createdAt :: Lens' GetCustomDataIdentifierResponse (Maybe UTCTime) Source #
The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.
getCustomDataIdentifierResponse_deleted :: Lens' GetCustomDataIdentifierResponse (Maybe Bool) Source #
Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.
getCustomDataIdentifierResponse_description :: Lens' GetCustomDataIdentifierResponse (Maybe Text) Source #
The custom description of the custom data identifier.
getCustomDataIdentifierResponse_id :: Lens' GetCustomDataIdentifierResponse (Maybe Text) Source #
The unique identifier for the custom data identifier.
getCustomDataIdentifierResponse_ignoreWords :: Lens' GetCustomDataIdentifierResponse (Maybe [Text]) Source #
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. Ignore words are case sensitive.
getCustomDataIdentifierResponse_keywords :: Lens' GetCustomDataIdentifierResponse (Maybe [Text]) Source #
An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.
getCustomDataIdentifierResponse_maximumMatchDistance :: Lens' GetCustomDataIdentifierResponse (Maybe Int) Source #
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. Otherwise, Macie excludes the result.
getCustomDataIdentifierResponse_name :: Lens' GetCustomDataIdentifierResponse (Maybe Text) Source #
The custom name of the custom data identifier.
getCustomDataIdentifierResponse_regex :: Lens' GetCustomDataIdentifierResponse (Maybe Text) Source #
The regular expression (regex) that defines the pattern to match.
getCustomDataIdentifierResponse_severityLevels :: Lens' GetCustomDataIdentifierResponse (Maybe [SeverityLevel]) Source #
Specifies the severity that's assigned to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier's detection criteria. By default, Amazon 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.
getCustomDataIdentifierResponse_tags :: Lens' GetCustomDataIdentifierResponse (Maybe (HashMap Text Text)) Source #
A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.
getCustomDataIdentifierResponse_httpStatus :: Lens' GetCustomDataIdentifierResponse Int Source #
The response's http status code.