GetFindingAggregator
Note
The aggregation Region is now called the home Region.
Returns the current configuration in the calling account for cross-Region aggregation. A finding aggregator is a resource that establishes the home Region and any linked Regions.
Request Syntax
GET /findingAggregator/get/FindingAggregatorArn+
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- FindingAggregatorArn
-
The ARN of the finding aggregator to return details for. To obtain the ARN, use
ListFindingAggregators
.Pattern:
.*\S.*
Required: Yes
Request Body
The request does not have a request body.
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.
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 Amazon account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
- ResourceNotFoundException
-
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: