Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
Parameters:
-
conformance_pack_names
(ConformancePackNamesToSummarizeList)
–
Names of conformance packs.
-
limit
(Optional[PageSizeLimit], default:
None
)
–
The maximum number of conformance packs returned on each page.
-
next_token
(Optional[NextToken], default:
None
)
–
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Raises:
Source code in docs_src/capo_config_service/_services/config_service.py
| def get_conformance_pack_compliance_summary(
self,
conformance_pack_names: "capo_config_service.types.conformance_pack_names_to_summarize_list.ConformancePackNamesToSummarizeList",
*,
config_overrides: Optional[ConfigServiceClientConfig] = None,
limit: Optional[
"capo_config_service.types.page_size_limit.PageSizeLimit"
] = None,
next_token: Optional["capo_config_service.types.next_token.NextToken"] = None,
) -> "capo_config_service.types.get_conformance_pack_compliance_summary_response.GetConformancePackComplianceSummaryResponse":
"""<p>Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.</p>
Args:
conformance_pack_names: <p>Names of conformance packs.</p>
limit: <p>The maximum number of conformance packs returned on each page.</p>
next_token: <p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>
Raises:
capo_config_service.errors.invalid_limit_exception.InvalidLimitException: <p>The specified limit is outside the allowable range.</p>
capo_config_service.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The specified next token is not valid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results.</p>
capo_config_service.errors.no_such_conformance_pack_exception.NoSuchConformancePackException: <p>You specified one or more conformance packs that do not exist.</p>
capo_config_service.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_config_service.types.get_conformance_pack_compliance_summary_request.GetConformancePackComplianceSummaryRequest]",
) -> OperationResponse[
"capo_config_service.types.get_conformance_pack_compliance_summary_response.GetConformancePackComplianceSummaryResponse"
]:
import capo_config_service._operations.starling_dove_service.get_conformance_pack_compliance_summary
output, http_response = (
capo_config_service._operations.starling_dove_service.get_conformance_pack_compliance_summary.get_conformance_pack_compliance_summary(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetConformancePackComplianceSummary")
)
input_: capo_config_service.types.get_conformance_pack_compliance_summary_request.GetConformancePackComplianceSummaryRequest = {
"conformance_pack_names": conformance_pack_names
}
if limit is not None:
input_["limit"] = limit
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
|