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.Inspector2.CreateFilter

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a filter resource using specified filter criteria.

Synopsis

data CreateFilter = CreateFilter' {
- description :: Maybe Text
- reason :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- action :: FilterAction
- filterCriteria :: FilterCriteria
- name :: Text
}
newCreateFilter :: FilterAction -> FilterCriteria -> Text -> CreateFilter
createFilter_description :: Lens' CreateFilter (Maybe Text)
createFilter_reason :: Lens' CreateFilter (Maybe Text)
createFilter_tags :: Lens' CreateFilter (Maybe (HashMap Text Text))
createFilter_action :: Lens' CreateFilter FilterAction
createFilter_filterCriteria :: Lens' CreateFilter FilterCriteria
createFilter_name :: Lens' CreateFilter Text
data CreateFilterResponse = CreateFilterResponse' {
- httpStatus :: Int
- arn :: Text
}
newCreateFilterResponse :: Int -> Text -> CreateFilterResponse
createFilterResponse_httpStatus :: Lens' CreateFilterResponse Int
createFilterResponse_arn :: Lens' CreateFilterResponse Text

Creating a Request

data CreateFilter Source #

See: newCreateFilter smart constructor.

Constructors

CreateFilter'

Fields

description :: Maybe Text
A description of the filter.
reason :: Maybe Text
The reason for creating the filter.
tags :: Maybe (HashMap Text Text)
A list of tags for the filter.
action :: FilterAction
Defines the action that is to be applied to the findings that match the filter.
filterCriteria :: FilterCriteria
Defines the criteria to be used in the filter for querying findings.
name :: Text
The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.

Instances

Instances details

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

newCreateFilter Source #

Arguments

:: FilterAction	`CreateFilter`
-> FilterCriteria	`$sel:filterCriteria:CreateFilter'`
-> Text	`CreateFilter`
-> CreateFilter

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

CreateFilter, createFilter_description - A description of the filter.

CreateFilter, createFilter_reason - The reason for creating the filter.

CreateFilter, createFilter_tags - A list of tags for the filter.

CreateFilter, createFilter_action - Defines the action that is to be applied to the findings that match the filter.

$sel:filterCriteria:CreateFilter', createFilter_filterCriteria - Defines the criteria to be used in the filter for querying findings.

CreateFilter, createFilter_name - The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.

Request Lenses

createFilter_description :: Lens' CreateFilter (Maybe Text) Source #

A description of the filter.

createFilter_reason :: Lens' CreateFilter (Maybe Text) Source #

The reason for creating the filter.

createFilter_tags :: Lens' CreateFilter (Maybe (HashMap Text Text)) Source #

A list of tags for the filter.

createFilter_action :: Lens' CreateFilter FilterAction Source #

Defines the action that is to be applied to the findings that match the filter.

createFilter_filterCriteria :: Lens' CreateFilter FilterCriteria Source #

Defines the criteria to be used in the filter for querying findings.

createFilter_name :: Lens' CreateFilter Text Source #

The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.

Destructuring the Response

data CreateFilterResponse Source #

See: newCreateFilterResponse smart constructor.

Constructors

CreateFilterResponse'
Fields httpStatus :: Int The response's http status code. arn :: Text The Amazon Resource Number (ARN) of the successfully created filter.

Instances

Instances details

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

newCreateFilterResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateFilterResponse'`
-> Text	`CreateFilterResponse`
-> CreateFilterResponse

Create a value of CreateFilterResponse 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:httpStatus:CreateFilterResponse', createFilterResponse_httpStatus - The response's http status code.

CreateFilterResponse, createFilterResponse_arn - The Amazon Resource Number (ARN) of the successfully created filter.

Response Lenses

createFilterResponse_httpStatus :: Lens' CreateFilterResponse Int Source #

The response's http status code.

createFilterResponse_arn :: Lens' CreateFilterResponse Text Source #

The Amazon Resource Number (ARN) of the successfully created filter.