Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.
Parameters:
-
policy_id
(PolicyId)
–
The ID of the Firewall Manager policy that you want the details for.
-
next_token
(Optional[PaginationToken], default:
None
)
–
If you specify a value for MaxResults and you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.
-
max_results
(Optional[PaginationMaxResults], default:
None
)
–
Specifies the number of PolicyComplianceStatus objects that you want Firewall Manager to return for this request. If you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicyComplianceStatus objects.
Raises:
Source code in docs_src/capo_fms/_services/async_fms.py
| async def list_compliance_status(
self,
policy_id: "capo_fms.types.policy_id.PolicyId",
*,
config_overrides: Optional[AsyncFMSClientConfig] = None,
next_token: Optional["capo_fms.types.pagination_token.PaginationToken"] = None,
max_results: Optional[
"capo_fms.types.pagination_max_results.PaginationMaxResults"
] = None,
) -> "capo_fms.types.list_compliance_status_response.ListComplianceStatusResponse":
"""<p>Returns an array of <code>PolicyComplianceStatus</code> objects. Use <code>PolicyComplianceStatus</code> to get a summary of which member accounts are protected by the specified policy. </p>
Args:
policy_id: <p>The ID of the Firewall Manager policy that you want the details for.</p>
next_token: <p>If you specify a value for <code>MaxResults</code> and you have more <code>PolicyComplianceStatus</code> objects than the number that you specify for <code>MaxResults</code>, Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list another group of <code>PolicyComplianceStatus</code> objects. For the second and subsequent <code>ListComplianceStatus</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of <code>PolicyComplianceStatus</code> objects.</p>
max_results: <p>Specifies the number of <code>PolicyComplianceStatus</code> objects that you want Firewall Manager to return for this request. If you have more <code>PolicyComplianceStatus</code> objects than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of <code>PolicyComplianceStatus</code> objects.</p>
Raises:
capo_fms.errors.internal_error_exception.InternalErrorException: <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
capo_fms.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
capo_fms.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_fms.types.list_compliance_status_request.ListComplianceStatusRequest]",
) -> AsyncOperationResponse[
"capo_fms.types.list_compliance_status_response.ListComplianceStatusResponse"
]:
import capo_fms._operations.awsfms_20180101.list_compliance_status
(
output,
http_response,
) = await capo_fms._operations.awsfms_20180101.list_compliance_status.async_list_compliance_status(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListComplianceStatus")
)
input_: capo_fms.types.list_compliance_status_request.ListComplianceStatusRequest = {
"policy_id": policy_id
}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|