Skip to content

describe_findings 

describe_findings(
    finding_arns: BatchDescribeArnList,
    *,
    config_overrides: Optional[InspectorClientConfig] = None,
    locale: Optional[Locale] = None,
) -> DescribeFindingsResponse

Describes the findings that are specified by the ARNs of the findings.

Parameters:

  • finding_arns (BatchDescribeArnList) –

    The ARN that specifies the finding that you want to describe.

  • locale (Optional[Locale], default: None ) –

    The locale into which you want to translate a finding description, recommendation, and the short description that identifies the finding.

Raises:

Source code in docs_src/capo_inspector/_services/inspector.py 
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
def describe_findings(
    self,
    finding_arns: "capo_inspector.types.batch_describe_arn_list.BatchDescribeArnList",
    *,
    config_overrides: Optional[InspectorClientConfig] = None,
    locale: Optional["capo_inspector.types.locale.Locale"] = None,
) -> "capo_inspector.types.describe_findings_response.DescribeFindingsResponse":
    """<p>Describes the findings that are specified by the ARNs of the findings.</p>

    Args:
        finding_arns: <p>The ARN that specifies the finding that you want to describe.</p>
        locale: <p>The locale into which you want to translate a finding description, recommendation, and the short description that identifies the finding.</p>

    Raises:
        capo_inspector.errors.internal_exception.InternalException: <p>Internal server error.</p>
        capo_inspector.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because an invalid or out-of-range value was supplied for an input parameter.</p>
        capo_inspector.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_inspector.types.describe_findings_request.DescribeFindingsRequest]",
    ) -> OperationResponse[
        "capo_inspector.types.describe_findings_response.DescribeFindingsResponse"
    ]:
        import capo_inspector._operations.inspector_service.describe_findings

        output, http_response = (
            capo_inspector._operations.inspector_service.describe_findings.describe_findings(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFindings")
    )
    input_: capo_inspector.types.describe_findings_request.DescribeFindingsRequest = {
        "finding_arns": finding_arns
    }
    if locale is not None:
        input_["locale"] = locale

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output