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 CSPM in the Security Hub CSPM User Guide.
Parameters:
-
region_linking_mode
(Optional[NonEmptyString], default:
None
)
–
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 CSPM 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 CSPM is enabled. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them.
-
ALL_REGIONS_EXCEPT_SPECIFIED - Aggregates findings from all of the Regions where Security Hub CSPM is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them.
-
SPECIFIED_REGIONS - Aggregates findings only from the Regions listed in the Regions parameter. Security Hub CSPM does not automatically aggregate findings from new Regions.
-
NO_REGIONS - Aggregates no data because no Regions are selected as linked Regions.
-
regions
(Optional[StringList], default:
None
)
–
If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do replicate and send findings to the home Region.
An InvalidInputException error results if you populate this field while RegionLinkingMode is NO_REGIONS.
Raises:
-
AccessDeniedException
–
You don't have permission to perform the action specified in the request.
-
InternalException
–
-
InvalidAccessException
–
The account doesn't have permission to perform this action.
-
InvalidInputException
–
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
LimitExceededException
–
The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Examples:
To enable cross-Region aggregation
The following example creates a finding aggregator. This is required to enable cross-Region aggregation.
>>> client.create_finding_aggregator(region_linking_mode='SPECIFIED_REGIONS', regions=['us-west-1', 'us-west-2'])
Source code in docs_src/capo_securityhub/_services/security_hub.py
| def create_finding_aggregator(
self,
*,
config_overrides: Optional[SecurityHubClientConfig] = None,
region_linking_mode: Optional[
"capo_securityhub.types.non_empty_string.NonEmptyString"
] = None,
regions: Optional["capo_securityhub.types.string_list.StringList"] = None,
) -> "capo_securityhub.types.create_finding_aggregator_response.CreateFindingAggregatorResponse":
"""<note> <p>The <i>aggregation Region</i> is now called the <i>home Region</i>.</p> </note> <p>Used to enable cross-Region aggregation. This operation can be invoked from the home Region only.</p> <p>For information about how cross-Region aggregation works, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/finding-aggregation.html">Understanding cross-Region aggregation in Security Hub CSPM</a> in the <i>Security Hub CSPM User Guide</i>. </p>
Args:
region_linking_mode: <p>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 CSPM supports them and you opt into them.</p> <p>The selected option also determines how to use the Regions provided in the Regions list.</p> <p>The options are as follows:</p> <ul> <li> <p> <code>ALL_REGIONS</code> - Aggregates findings from all of the Regions where Security Hub CSPM is enabled. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them. </p> </li> <li> <p> <code>ALL_REGIONS_EXCEPT_SPECIFIED</code> - Aggregates findings from all of the Regions where Security Hub CSPM is enabled, except for the Regions listed in the <code>Regions</code> parameter. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them. </p> </li> <li> <p> <code>SPECIFIED_REGIONS</code> - Aggregates findings only from the Regions listed in the <code>Regions</code> parameter. Security Hub CSPM does not automatically aggregate findings from new Regions. </p> </li> <li> <p> <code>NO_REGIONS</code> - Aggregates no data because no Regions are selected as linked Regions. </p> </li> </ul>
regions: <p>If <code>RegionLinkingMode</code> is <code>ALL_REGIONS_EXCEPT_SPECIFIED</code>, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.</p> <p>If <code>RegionLinkingMode</code> is <code>SPECIFIED_REGIONS</code>, then this is a space-separated list of Regions that do replicate and send findings to the home Region. </p> <p>An <code>InvalidInputException</code> error results if you populate this field while <code>RegionLinkingMode</code> is <code>NO_REGIONS</code>.</p>
Raises:
capo_securityhub.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action specified in the request.</p>
capo_securityhub.errors.internal_exception.InternalException: <p>Internal server error.</p>
capo_securityhub.errors.invalid_access_exception.InvalidAccessException: <p>The account doesn't have permission to perform this action.</p>
capo_securityhub.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because you supplied an invalid or out-of-range value for an input parameter.</p>
capo_securityhub.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.</p>
capo_securityhub.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To enable cross-Region aggregation
The following example creates a finding aggregator. This is required to enable cross-Region aggregation.
>>> client.create_finding_aggregator(region_linking_mode='SPECIFIED_REGIONS', regions=['us-west-1', 'us-west-2'])
"""
def _handler(
req: "OperationRequest[capo_securityhub.types.create_finding_aggregator_request.CreateFindingAggregatorRequest]",
) -> OperationResponse[
"capo_securityhub.types.create_finding_aggregator_response.CreateFindingAggregatorResponse"
]:
import capo_securityhub._operations.security_hub_api_service.create_finding_aggregator
output, http_response = (
capo_securityhub._operations.security_hub_api_service.create_finding_aggregator.create_finding_aggregator(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CreateFindingAggregator")
)
input_: capo_securityhub.types.create_finding_aggregator_request.CreateFindingAggregatorRequest = {}
if region_linking_mode is not None:
input_["region_linking_mode"] = region_linking_mode
if regions is not None:
input_["regions"] = regions
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|