Skip to content

list_audit_mitigation_actions_executions

list_audit_mitigation_actions_executions(
    task_id: MitigationActionsTaskId,
    finding_id: FindingId,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    action_status: Optional[AuditMitigationActionsExecutionStatus] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListAuditMitigationActionsExecutionsResponse

Gets the status of audit mitigation action tasks that were executed.

Requires permission to access the ListAuditMitigationActionsExecutions action.

Parameters:

  • task_id (MitigationActionsTaskId) –

    Specify this filter to limit results to actions for a specific audit mitigation actions task.

  • action_status (Optional[AuditMitigationActionsExecutionStatus], default: None ) –

    Specify this filter to limit results to those with a specific status.

  • finding_id (FindingId) –

    Specify this filter to limit results to those that were applied to a specific audit finding.

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

    The maximum number of results to return at one time. The default is 25.

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

    The token for the next set of results.

Raises:

Source code in docs_src/capo_iot/_services/io_t.py
def list_audit_mitigation_actions_executions(
    self,
    task_id: "capo_iot.types.mitigation_actions_task_id.MitigationActionsTaskId",
    finding_id: "capo_iot.types.finding_id.FindingId",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    action_status: Optional[
        "capo_iot.types.audit_mitigation_actions_execution_status.AuditMitigationActionsExecutionStatus"
    ] = None,
    max_results: Optional["capo_iot.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_iot.types.next_token.NextToken"] = None,
) -> "capo_iot.types.list_audit_mitigation_actions_executions_response.ListAuditMitigationActionsExecutionsResponse":
    """<p>Gets the status of audit mitigation action tasks that were executed.</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">ListAuditMitigationActionsExecutions</a> action.</p>

    Args:
        task_id: <p>Specify this filter to limit results to actions for a specific audit mitigation actions task.</p>
        action_status: <p>Specify this filter to limit results to those with a specific status.</p>
        finding_id: <p>Specify this filter to limit results to those that were applied to a specific audit finding.</p>
        max_results: <p>The maximum number of results to return at one time. The default is 25.</p>
        next_token: <p>The token for the next set of results.</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.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.list_audit_mitigation_actions_executions_request.ListAuditMitigationActionsExecutionsRequest]",
    ) -> OperationResponse[
        "capo_iot.types.list_audit_mitigation_actions_executions_response.ListAuditMitigationActionsExecutionsResponse"
    ]:
        import capo_iot._operations.aws_iot_service.list_audit_mitigation_actions_executions

        output, http_response = (
            capo_iot._operations.aws_iot_service.list_audit_mitigation_actions_executions.list_audit_mitigation_actions_executions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAuditMitigationActionsExecutions")
    )
    input_: capo_iot.types.list_audit_mitigation_actions_executions_request.ListAuditMitigationActionsExecutionsRequest = {
        "task_id": task_id,
        "finding_id": finding_id,
    }
    if action_status is not None:
        input_["action_status"] = action_status
    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