Lists coverage details for your environment.
Parameters:
-
max_results
(Optional[ListCoverageMaxResults], default:
None
)
–
The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.
-
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. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
-
filter_criteria
(Optional[CoverageFilterCriteria], default:
None
)
–
An object that contains details on the filters to apply to the coverage data for your environment.
Raises:
Source code in docs_src/capo_inspector2/_services/inspector2.py
| def list_coverage(
self,
*,
config_overrides: Optional[Inspector2ClientConfig] = None,
max_results: Optional[
"capo_inspector2.types.list_coverage_max_results.ListCoverageMaxResults"
] = None,
next_token: Optional["capo_inspector2.types.next_token.NextToken"] = None,
filter_criteria: Optional[
"capo_inspector2.types.coverage_filter_criteria.CoverageFilterCriteria"
] = None,
) -> "capo_inspector2.types.list_coverage_response.ListCoverageResponse":
"""<p>Lists coverage details for your environment.</p>
Args:
max_results: <p>The maximum number of results the response can return. If your request would return more than the maximum the response will return a <code>nextToken</code> value, use this value when you call the action again to get the remaining results.</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. If your response returns more than the <code>maxResults</code> maximum value it will also return a <code>nextToken</code> value. For subsequent calls, use the <code>nextToken</code> value returned from the previous request to continue listing results after the first page.</p>
filter_criteria: <p>An object that contains details on the filters to apply to the coverage data for your environment.</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_request.ListCoverageRequest]",
) -> OperationResponse[
"capo_inspector2.types.list_coverage_response.ListCoverageResponse"
]:
import capo_inspector2._operations.inspector2.list_coverage
output, http_response = (
capo_inspector2._operations.inspector2.list_coverage.list_coverage(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListCoverage")
)
input_: capo_inspector2.types.list_coverage_request.ListCoverageRequest = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
if filter_criteria is not None:
input_["filter_criteria"] = filter_criteria
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|