Skip to content

list_incident_findings

list_incident_findings(
    incident_record_arn: Arn,
    *,
    config_overrides: Optional[SSMIncidentsClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[NextToken] = None,
) -> ListIncidentFindingsOutput

Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident. A finding represents a recent application environment change made by an CloudFormation stack creation or update or an CodeDeploy deployment 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 associated findings.

  • max_results (Optional[int], default: None ) –

    The maximum number of findings to retrieve per call.

  • next_token (Optional[NextToken], default: None ) –

    The pagination token for the next set of items to return. (You received this token from a previous call.)

Raises:

Source code in docs_src/capo_ssm_incidents/_services/ssm_incidents.py
def list_incident_findings(
    self,
    incident_record_arn: "capo_ssm_incidents.types.arn.Arn",
    *,
    config_overrides: Optional[SSMIncidentsClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional["capo_ssm_incidents.types.next_token.NextToken"] = None,
) -> "capo_ssm_incidents.types.list_incident_findings_output.ListIncidentFindingsOutput":
    """<p>Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident. A finding represents a recent application environment change made by an CloudFormation stack creation or update or an CodeDeploy deployment 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 associated findings.</p>
        max_results: <p>The maximum number of findings to retrieve per call.</p>
        next_token: <p>The pagination token for the next set of items to return. (You received this token from a previous call.)</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.list_incident_findings_input.ListIncidentFindingsInput]",
    ) -> OperationResponse[
        "capo_ssm_incidents.types.list_incident_findings_output.ListIncidentFindingsOutput"
    ]:
        import capo_ssm_incidents._operations.ssm_incidents.list_incident_findings

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListIncidentFindings")
    )
    input_: capo_ssm_incidents.types.list_incident_findings_input.ListIncidentFindingsInput = {
        "incident_record_arn": incident_record_arn
    }
    if max_results is not None:
        input_["max_results"] = max_results
    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