Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SecurityHub.UpdateFindingAggregator

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use UpdateFindingAggregator to change the aggregation Region.

You must run UpdateFindingAggregator from the current aggregation Region.

Synopsis

Creating a Request

data UpdateFindingAggregator Source #

See: newUpdateFindingAggregator smart constructor.

Constructors

UpdateFindingAggregator'

Fields

regions :: Maybe [Text]
If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated list of Regions that do aggregate findings to the aggregation Region.
findingAggregatorArn :: Text
The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.
regionLinkingMode :: Text
Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.
The selected option also determines how to use the Regions provided in the Regions list.
The options are as follows:
- ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
- ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
- SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.

Instances

Instances details

Eq UpdateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Methods (==) :: UpdateFindingAggregator -> UpdateFindingAggregator -> Bool # (/=) :: UpdateFindingAggregator -> UpdateFindingAggregator -> Bool #
Read UpdateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Methods readsPrec :: Int -> ReadS UpdateFindingAggregator # readList :: ReadS [UpdateFindingAggregator] # readPrec :: ReadPrec UpdateFindingAggregator # readListPrec :: ReadPrec [UpdateFindingAggregator] #
Show UpdateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Methods showsPrec :: Int -> UpdateFindingAggregator -> ShowS # show :: UpdateFindingAggregator -> String # showList :: [UpdateFindingAggregator] -> ShowS #
Generic UpdateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Associated Types type Rep UpdateFindingAggregator :: Type -> Type # Methods from :: UpdateFindingAggregator -> Rep UpdateFindingAggregator x # to :: Rep UpdateFindingAggregator x -> UpdateFindingAggregator #
NFData UpdateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Methods rnf :: UpdateFindingAggregator -> () #
Hashable UpdateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Methods hashWithSalt :: Int -> UpdateFindingAggregator -> Int # hash :: UpdateFindingAggregator -> Int #
ToJSON UpdateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Methods toJSON :: UpdateFindingAggregator -> Value # toEncoding :: UpdateFindingAggregator -> Encoding # toJSONList :: [UpdateFindingAggregator] -> Value # toEncodingList :: [UpdateFindingAggregator] -> Encoding #
AWSRequest UpdateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Associated Types type AWSResponse UpdateFindingAggregator # Methods request :: UpdateFindingAggregator -> Request UpdateFindingAggregator # response :: MonadResource m => Logger -> Service -> Proxy UpdateFindingAggregator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateFindingAggregator))) #
ToHeaders UpdateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Methods toHeaders :: UpdateFindingAggregator -> [Header] #
ToPath UpdateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Methods toPath :: UpdateFindingAggregator -> ByteString #
ToQuery UpdateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Methods toQuery :: UpdateFindingAggregator -> QueryString #
type Rep UpdateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator type Rep UpdateFindingAggregator = D1 ('MetaData "UpdateFindingAggregator" "Amazonka.SecurityHub.UpdateFindingAggregator" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "UpdateFindingAggregator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "regions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "findingAggregatorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "regionLinkingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator type AWSResponse UpdateFindingAggregator = UpdateFindingAggregatorResponse

newUpdateFindingAggregator Source #

Arguments

:: Text	`$sel:findingAggregatorArn:UpdateFindingAggregator'`
-> Text	`$sel:regionLinkingMode:UpdateFindingAggregator'`
-> UpdateFindingAggregator

Create a value of UpdateFindingAggregator 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:regions:UpdateFindingAggregator', updateFindingAggregator_regions - If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated list of Regions that do not aggregate findings to the aggregation Region.

If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated list of Regions that do aggregate findings to the aggregation Region.

$sel:findingAggregatorArn:UpdateFindingAggregator', updateFindingAggregator_findingAggregatorArn - The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.

$sel:regionLinkingMode:UpdateFindingAggregator', updateFindingAggregator_regionLinkingMode - Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.

The selected option also determines how to use the Regions provided in the Regions list.

The options are as follows:

ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.

Request Lenses

updateFindingAggregator_regions :: Lens' UpdateFindingAggregator (Maybe [Text]) Source #

If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated list of Regions that do not aggregate findings to the aggregation Region.

If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated list of Regions that do aggregate findings to the aggregation Region.

updateFindingAggregator_findingAggregatorArn :: Lens' UpdateFindingAggregator Text Source #

The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.

updateFindingAggregator_regionLinkingMode :: Lens' UpdateFindingAggregator Text Source #

Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.

The selected option also determines how to use the Regions provided in the Regions list.

The options are as follows:

ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.

Destructuring the Response

data UpdateFindingAggregatorResponse Source #

See: newUpdateFindingAggregatorResponse smart constructor.

Constructors

UpdateFindingAggregatorResponse'

Fields

regions :: Maybe [Text]
The list of excluded Regions or included Regions.
findingAggregatorArn :: Maybe Text
The ARN of the finding aggregator.
regionLinkingMode :: Maybe Text
Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
findingAggregationRegion :: Maybe Text
The aggregation Region.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq UpdateFindingAggregatorResponse Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Methods (==) :: UpdateFindingAggregatorResponse -> UpdateFindingAggregatorResponse -> Bool # (/=) :: UpdateFindingAggregatorResponse -> UpdateFindingAggregatorResponse -> Bool #
Read UpdateFindingAggregatorResponse Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Methods readsPrec :: Int -> ReadS UpdateFindingAggregatorResponse # readList :: ReadS [UpdateFindingAggregatorResponse] # readPrec :: ReadPrec UpdateFindingAggregatorResponse # readListPrec :: ReadPrec [UpdateFindingAggregatorResponse] #
Show UpdateFindingAggregatorResponse Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Methods showsPrec :: Int -> UpdateFindingAggregatorResponse -> ShowS # show :: UpdateFindingAggregatorResponse -> String # showList :: [UpdateFindingAggregatorResponse] -> ShowS #
Generic UpdateFindingAggregatorResponse Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Associated Types type Rep UpdateFindingAggregatorResponse :: Type -> Type # Methods from :: UpdateFindingAggregatorResponse -> Rep UpdateFindingAggregatorResponse x # to :: Rep UpdateFindingAggregatorResponse x -> UpdateFindingAggregatorResponse #
NFData UpdateFindingAggregatorResponse Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator Methods rnf :: UpdateFindingAggregatorResponse -> () #
type Rep UpdateFindingAggregatorResponse Source #
Instance details Defined in Amazonka.SecurityHub.UpdateFindingAggregator type Rep UpdateFindingAggregatorResponse = D1 ('MetaData "UpdateFindingAggregatorResponse" "Amazonka.SecurityHub.UpdateFindingAggregator" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "UpdateFindingAggregatorResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "regions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "findingAggregatorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "regionLinkingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "findingAggregationRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newUpdateFindingAggregatorResponse Source #

Arguments

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

Create a value of UpdateFindingAggregatorResponse 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:regions:UpdateFindingAggregator', updateFindingAggregatorResponse_regions - The list of excluded Regions or included Regions.

$sel:findingAggregatorArn:UpdateFindingAggregator', updateFindingAggregatorResponse_findingAggregatorArn - The ARN of the finding aggregator.

$sel:regionLinkingMode:UpdateFindingAggregator', updateFindingAggregatorResponse_regionLinkingMode - Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.

$sel:findingAggregationRegion:UpdateFindingAggregatorResponse', updateFindingAggregatorResponse_findingAggregationRegion - The aggregation Region.

$sel:httpStatus:UpdateFindingAggregatorResponse', updateFindingAggregatorResponse_httpStatus - The response's http status code.

Response Lenses

updateFindingAggregatorResponse_regions :: Lens' UpdateFindingAggregatorResponse (Maybe [Text]) Source #

The list of excluded Regions or included Regions.

updateFindingAggregatorResponse_findingAggregatorArn :: Lens' UpdateFindingAggregatorResponse (Maybe Text) Source #

The ARN of the finding aggregator.

updateFindingAggregatorResponse_regionLinkingMode :: Lens' UpdateFindingAggregatorResponse (Maybe Text) Source #

Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.

updateFindingAggregatorResponse_findingAggregationRegion :: Lens' UpdateFindingAggregatorResponse (Maybe Text) Source #

The aggregation Region.

updateFindingAggregatorResponse_httpStatus :: Lens' UpdateFindingAggregatorResponse Int Source #

The response's http status code.