Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.
Requires permission to access the DescribeAuditFinding action.
Parameters:
-
finding_id
(FindingId)
–
A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.
Raises:
Source code in docs_src/capo_iot/_services/io_t.py
| def describe_audit_finding(
self,
finding_id: "capo_iot.types.finding_id.FindingId",
*,
config_overrides: Optional[IoTClientConfig] = None,
) -> "capo_iot.types.describe_audit_finding_response.DescribeAuditFindingResponse":
"""<p>Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeAuditFinding</a> action.</p>
Args:
finding_id: <p>A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.</p>
Raises:
capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_iot.types.describe_audit_finding_request.DescribeAuditFindingRequest]",
) -> OperationResponse[
"capo_iot.types.describe_audit_finding_response.DescribeAuditFindingResponse"
]:
import capo_iot._operations.aws_iot_service.describe_audit_finding
output, http_response = (
capo_iot._operations.aws_iot_service.describe_audit_finding.describe_audit_finding(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeAuditFinding")
)
input_: capo_iot.types.describe_audit_finding_request.DescribeAuditFindingRequest = {
"finding_id": finding_id
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|