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

Amazonka.MacieV2.CreateFindingsFilter

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates and defines the criteria and other settings for a findings filter.

Synopsis

data CreateFindingsFilter = CreateFindingsFilter' {
- clientToken :: Maybe Text
- description :: Maybe Text
- position :: Maybe Int
- tags :: Maybe (HashMap Text Text)
- action :: FindingsFilterAction
- findingCriteria :: FindingCriteria
- name :: Text
}
newCreateFindingsFilter :: FindingsFilterAction -> FindingCriteria -> Text -> CreateFindingsFilter
createFindingsFilter_clientToken :: Lens' CreateFindingsFilter (Maybe Text)
createFindingsFilter_description :: Lens' CreateFindingsFilter (Maybe Text)
createFindingsFilter_position :: Lens' CreateFindingsFilter (Maybe Int)
createFindingsFilter_tags :: Lens' CreateFindingsFilter (Maybe (HashMap Text Text))
createFindingsFilter_action :: Lens' CreateFindingsFilter FindingsFilterAction
createFindingsFilter_findingCriteria :: Lens' CreateFindingsFilter FindingCriteria
createFindingsFilter_name :: Lens' CreateFindingsFilter Text
data CreateFindingsFilterResponse = CreateFindingsFilterResponse' {
- arn :: Maybe Text
- id :: Maybe Text
- httpStatus :: Int
}
newCreateFindingsFilterResponse :: Int -> CreateFindingsFilterResponse
createFindingsFilterResponse_arn :: Lens' CreateFindingsFilterResponse (Maybe Text)
createFindingsFilterResponse_id :: Lens' CreateFindingsFilterResponse (Maybe Text)
createFindingsFilterResponse_httpStatus :: Lens' CreateFindingsFilterResponse Int

Creating a Request

data CreateFindingsFilter Source #

See: newCreateFindingsFilter smart constructor.

Constructors

CreateFindingsFilter'

Fields

clientToken :: Maybe Text
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
description :: Maybe Text
A custom description of the filter. The description can contain as many as 512 characters.
We strongly recommend that you avoid including any sensitive data in the description of a filter. 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.
position :: Maybe Int
The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.
tags :: Maybe (HashMap Text Text)
A map of key-value pairs that specifies the tags to associate with the filter.
A findings filter 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.
action :: FindingsFilterAction
The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
findingCriteria :: FindingCriteria
The criteria to use to filter findings.
name :: Text
A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.
We strongly recommend that you avoid including any sensitive data in the name of a filter. 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.

Instances

Instances details

ToJSON CreateFindingsFilter Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Methods toJSON :: CreateFindingsFilter -> Value # toEncoding :: CreateFindingsFilter -> Encoding # toJSONList :: [CreateFindingsFilter] -> Value # toEncodingList :: [CreateFindingsFilter] -> Encoding #
ToHeaders CreateFindingsFilter Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Methods toHeaders :: CreateFindingsFilter -> [Header] #
ToPath CreateFindingsFilter Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Methods toPath :: CreateFindingsFilter -> ByteString #
ToQuery CreateFindingsFilter Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Methods toQuery :: CreateFindingsFilter -> QueryString #
AWSRequest CreateFindingsFilter Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Associated Types type AWSResponse CreateFindingsFilter # Methods request :: (Service -> Service) -> CreateFindingsFilter -> Request CreateFindingsFilter # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateFindingsFilter -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFindingsFilter))) #
Generic CreateFindingsFilter Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Associated Types type Rep CreateFindingsFilter :: Type -> Type # Methods from :: CreateFindingsFilter -> Rep CreateFindingsFilter x # to :: Rep CreateFindingsFilter x -> CreateFindingsFilter #
Read CreateFindingsFilter Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Methods readsPrec :: Int -> ReadS CreateFindingsFilter # readList :: ReadS [CreateFindingsFilter] # readPrec :: ReadPrec CreateFindingsFilter # readListPrec :: ReadPrec [CreateFindingsFilter] #
Show CreateFindingsFilter Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Methods showsPrec :: Int -> CreateFindingsFilter -> ShowS # show :: CreateFindingsFilter -> String # showList :: [CreateFindingsFilter] -> ShowS #
NFData CreateFindingsFilter Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Methods rnf :: CreateFindingsFilter -> () #
Eq CreateFindingsFilter Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Methods (==) :: CreateFindingsFilter -> CreateFindingsFilter -> Bool # (/=) :: CreateFindingsFilter -> CreateFindingsFilter -> Bool #
Hashable CreateFindingsFilter Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Methods hashWithSalt :: Int -> CreateFindingsFilter -> Int # hash :: CreateFindingsFilter -> Int #
type AWSResponse CreateFindingsFilter Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter type AWSResponse CreateFindingsFilter = CreateFindingsFilterResponse
type Rep CreateFindingsFilter Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter type Rep CreateFindingsFilter = D1 ('MetaData "CreateFindingsFilter" "Amazonka.MacieV2.CreateFindingsFilter" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "CreateFindingsFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FindingsFilterAction)) :: (S1 ('MetaSel ('Just "findingCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FindingCriteria) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateFindingsFilter Source #

Arguments

:: FindingsFilterAction	`CreateFindingsFilter`
-> FindingCriteria	`$sel:findingCriteria:CreateFindingsFilter'`
-> Text	`CreateFindingsFilter`
-> CreateFindingsFilter

Create a value of CreateFindingsFilter 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:

$sel:clientToken:CreateFindingsFilter', createFindingsFilter_clientToken - A unique, case-sensitive token that you provide to ensure the idempotency of the request.

CreateFindingsFilter, createFindingsFilter_description - A custom description of the filter. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a filter. 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.

$sel:position:CreateFindingsFilter', createFindingsFilter_position - The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

CreateFindingsFilter, createFindingsFilter_tags - A map of key-value pairs that specifies the tags to associate with the filter.

A findings filter 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.

CreateFindingsFilter, createFindingsFilter_action - The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

$sel:findingCriteria:CreateFindingsFilter', createFindingsFilter_findingCriteria - The criteria to use to filter findings.

CreateFindingsFilter, createFindingsFilter_name - A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

We strongly recommend that you avoid including any sensitive data in the name of a filter. 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.

Request Lenses

createFindingsFilter_clientToken :: Lens' CreateFindingsFilter (Maybe Text) Source #

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

createFindingsFilter_description :: Lens' CreateFindingsFilter (Maybe Text) Source #

A custom description of the filter. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a filter. 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.

createFindingsFilter_position :: Lens' CreateFindingsFilter (Maybe Int) Source #

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

createFindingsFilter_tags :: Lens' CreateFindingsFilter (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that specifies the tags to associate with the filter.

A findings filter 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.

createFindingsFilter_action :: Lens' CreateFindingsFilter FindingsFilterAction Source #

The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

createFindingsFilter_findingCriteria :: Lens' CreateFindingsFilter FindingCriteria Source #

The criteria to use to filter findings.

createFindingsFilter_name :: Lens' CreateFindingsFilter Text Source #

A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

We strongly recommend that you avoid including any sensitive data in the name of a filter. 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.

Destructuring the Response

data CreateFindingsFilterResponse Source #

See: newCreateFindingsFilterResponse smart constructor.

Constructors

CreateFindingsFilterResponse'
Fields arn :: Maybe Text The Amazon Resource Name (ARN) of the filter that was created. id :: Maybe Text The unique identifier for the filter that was created. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateFindingsFilterResponse Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Associated Types type Rep CreateFindingsFilterResponse :: Type -> Type # Methods from :: CreateFindingsFilterResponse -> Rep CreateFindingsFilterResponse x # to :: Rep CreateFindingsFilterResponse x -> CreateFindingsFilterResponse #
Read CreateFindingsFilterResponse Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Methods readsPrec :: Int -> ReadS CreateFindingsFilterResponse # readList :: ReadS [CreateFindingsFilterResponse] # readPrec :: ReadPrec CreateFindingsFilterResponse # readListPrec :: ReadPrec [CreateFindingsFilterResponse] #
Show CreateFindingsFilterResponse Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Methods showsPrec :: Int -> CreateFindingsFilterResponse -> ShowS # show :: CreateFindingsFilterResponse -> String # showList :: [CreateFindingsFilterResponse] -> ShowS #
NFData CreateFindingsFilterResponse Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Methods rnf :: CreateFindingsFilterResponse -> () #
Eq CreateFindingsFilterResponse Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter Methods (==) :: CreateFindingsFilterResponse -> CreateFindingsFilterResponse -> Bool # (/=) :: CreateFindingsFilterResponse -> CreateFindingsFilterResponse -> Bool #
type Rep CreateFindingsFilterResponse Source #
Instance details Defined in Amazonka.MacieV2.CreateFindingsFilter type Rep CreateFindingsFilterResponse = D1 ('MetaData "CreateFindingsFilterResponse" "Amazonka.MacieV2.CreateFindingsFilter" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "CreateFindingsFilterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateFindingsFilterResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateFindingsFilterResponse'`
-> CreateFindingsFilterResponse

Create a value of CreateFindingsFilterResponse 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:

CreateFindingsFilterResponse, createFindingsFilterResponse_arn - The Amazon Resource Name (ARN) of the filter that was created.

CreateFindingsFilterResponse, createFindingsFilterResponse_id - The unique identifier for the filter that was created.

$sel:httpStatus:CreateFindingsFilterResponse', createFindingsFilterResponse_httpStatus - The response's http status code.

Response Lenses

createFindingsFilterResponse_arn :: Lens' CreateFindingsFilterResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the filter that was created.

createFindingsFilterResponse_id :: Lens' CreateFindingsFilterResponse (Maybe Text) Source #

The unique identifier for the filter that was created.

createFindingsFilterResponse_httpStatus :: Lens' CreateFindingsFilterResponse Int Source #

The response's http status code.