CreateFindingAggregator
Note
The aggregation Region is now called the home Region.
Used to enable cross-Region aggregation. This operation can be invoked from the home Region only.
For information about how cross-Region aggregation works, see Understanding cross-Region aggregation in Security Hub in the AWS Security Hub User Guide.
Request Syntax
POST /findingAggregator/create HTTP/1.1
Content-type: application/json
{
"RegionLinkingMode": "string",
"Regions": [ "string" ]
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- 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- Aggregates 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- Aggregates findings from all of the Regions where Security Hub is enabled, except for the Regions listed in theRegionsparameter. 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- Aggregates findings only from the Regions listed in theRegionsparameter. Security Hub does not automatically aggregate findings from new Regions. -
NO_REGIONS- Aggregates no data because no Regions are selected as linked Regions.
Type: String
Pattern:
.*\S.*Required: Yes
-
- Regions
-
If
RegionLinkingModeisALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.If
RegionLinkingModeisSPECIFIED_REGIONS, then this is a space-separated list of Regions that do replicate and send findings to the home Region.An
InvalidInputExceptionerror results if you populate this field whileRegionLinkingModeisNO_REGIONS.Type: Array of strings
Pattern:
.*\S.*Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"FindingAggregationRegion": "string",
"FindingAggregatorArn": "string",
"RegionLinkingMode": "string",
"Regions": [ "string" ]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- FindingAggregationRegion
-
The home Region. Findings generated in linked Regions are replicated and sent to the home Region.
Type: String
Pattern:
.*\S.* - FindingAggregatorArn
-
The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop cross-Region aggregation.
Type: String
Pattern:
.*\S.* - RegionLinkingMode
-
Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
Type: String
Pattern:
.*\S.* - Regions
-
The list of excluded Regions or included Regions.
Type: Array of strings
Pattern:
.*\S.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
- InternalException
-
Internal server error.
HTTP Status Code: 500
- InvalidAccessException
-
The account doesn't have permission to perform this action.
HTTP Status Code: 401
- InvalidInputException
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
- LimitExceededException
-
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
