Lists Amazon Inspector coverage statistics for your environment.
Parameters:
-
filter_criteria
(Optional[CoverageFilterCriteria], default:
None
)
–
An object that contains details on the filters to apply to the coverage data for your environment.
-
group_by
(Optional[GroupKey], default:
None
)
–
The value to group the results by.
-
next_token
(Optional[NextToken], default:
None
)
–
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
Raises:
Source code in docs_src/capo_inspector2/_services/inspector2.py
| def list_coverage_statistics(
self,
*,
config_overrides: Optional[Inspector2ClientConfig] = None,
filter_criteria: Optional[
"capo_inspector2.types.coverage_filter_criteria.CoverageFilterCriteria"
] = None,
group_by: Optional["capo_inspector2.types.group_key.GroupKey"] = None,
next_token: Optional["capo_inspector2.types.next_token.NextToken"] = None,
) -> "capo_inspector2.types.list_coverage_statistics_response.ListCoverageStatisticsResponse":
"""<p>Lists Amazon Inspector coverage statistics for your environment.</p>
Args:
filter_criteria: <p>An object that contains details on the filters to apply to the coverage data for your environment.</p>
group_by: <p>The value to group the results by.</p>
next_token: <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>
Raises:
capo_inspector2.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal failure of the Amazon Inspector service.</p>
capo_inspector2.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
capo_inspector2.errors.validation_exception.ValidationException: <p>The request has failed validation due to missing required fields or having invalid inputs.</p>
capo_inspector2.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_inspector2.types.list_coverage_statistics_request.ListCoverageStatisticsRequest]",
) -> OperationResponse[
"capo_inspector2.types.list_coverage_statistics_response.ListCoverageStatisticsResponse"
]:
import capo_inspector2._operations.inspector2.list_coverage_statistics
output, http_response = (
capo_inspector2._operations.inspector2.list_coverage_statistics.list_coverage_statistics(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListCoverageStatistics")
)
input_: capo_inspector2.types.list_coverage_statistics_request.ListCoverageStatisticsRequest = {}
if filter_criteria is not None:
input_["filter_criteria"] = filter_criteria
if group_by is not None:
input_["group_by"] = group_by
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|