Skip to content

batch_get_incident_findings

batch_get_incident_findings(
    incident_record_arn: Arn,
    finding_ids: FindingIdList,
    *,
    config_overrides: Optional[SSMIncidentsClientConfig] = None,
) -> BatchGetIncidentFindingsOutput

Retrieves details about all specified findings for an incident, including descriptive details about each finding. A finding represents a recent application environment change made by an CodeDeploy deployment or an CloudFormation stack creation or update that can be investigated as a potential cause of the incident.

Parameters:

  • incident_record_arn (Arn) –

    The Amazon Resource Name (ARN) of the incident for which you want to view finding details.

  • finding_ids (FindingIdList) –

    A list of IDs of findings for which you want to view details.

Raises:

Source code in docs_src/capo_ssm_incidents/_services/ssm_incidents.py
def batch_get_incident_findings(
    self,
    incident_record_arn: "capo_ssm_incidents.types.arn.Arn",
    finding_ids: "capo_ssm_incidents.types.finding_id_list.FindingIdList",
    *,
    config_overrides: Optional[SSMIncidentsClientConfig] = None,
) -> "capo_ssm_incidents.types.batch_get_incident_findings_output.BatchGetIncidentFindingsOutput":
    """<p>Retrieves details about all specified findings for an incident, including descriptive details about each finding. A finding represents a recent application environment change made by an CodeDeploy deployment or an CloudFormation stack creation or update that can be investigated as a potential cause of the incident.</p>

    Args:
        incident_record_arn: <p>The Amazon Resource Name (ARN) of the incident for which you want to view finding details.</p>
        finding_ids: <p>A list of IDs of findings for which you want to view details.</p>

    Raises:
        capo_ssm_incidents.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this operation.</p>
        capo_ssm_incidents.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_ssm_incidents.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which doesn't exist. </p>
        capo_ssm_incidents.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_ssm_incidents.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_ssm_incidents.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm_incidents.types.batch_get_incident_findings_input.BatchGetIncidentFindingsInput]",
    ) -> OperationResponse[
        "capo_ssm_incidents.types.batch_get_incident_findings_output.BatchGetIncidentFindingsOutput"
    ]:
        import capo_ssm_incidents._operations.ssm_incidents.batch_get_incident_findings

        output, http_response = (
            capo_ssm_incidents._operations.ssm_incidents.batch_get_incident_findings.batch_get_incident_findings(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchGetIncidentFindings")
    )
    input_: capo_ssm_incidents.types.batch_get_incident_findings_input.BatchGetIncidentFindingsInput = {
        "incident_record_arn": incident_record_arn,
        "finding_ids": finding_ids,
    }

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