Skip to content

get_case_audit_events

get_case_audit_events(
    case_id: CaseId,
    domain_id: DomainId,
    *,
    config_overrides: Optional[ConnectCasesClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[NextToken] = None,
) -> GetCaseAuditEventsResponse

Returns the audit history about a specific case if it exists.

Parameters:

  • case_id (CaseId) –

    A unique identifier of the case.

  • domain_id (DomainId) –

    The unique identifier of the Cases domain.

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

    The maximum number of audit events to return. When no value is provided, 25 is the default.

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

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Raises:

  • AccessDeniedException –

    You do not have sufficient access to perform this action.

  • InternalServerException –

    We couldn't process your request because of an issue with the server. Try again later.

  • ResourceNotFoundException –

    We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

  • ThrottlingException –

    The rate has been exceeded for this API. Please try again after a few minutes.

  • ValidationException –

    The request isn't valid. Check the syntax and try again.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_connectcases/_services/connect_cases.py
def get_case_audit_events(
    self,
    case_id: "capo_connectcases.types.case_id.CaseId",
    domain_id: "capo_connectcases.types.domain_id.DomainId",
    *,
    config_overrides: Optional[ConnectCasesClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional["capo_connectcases.types.next_token.NextToken"] = None,
) -> "capo_connectcases.types.get_case_audit_events_response.GetCaseAuditEventsResponse":
    """<p>Returns the audit history about a specific case if it exists.</p>

    Args:
        case_id: <p>A unique identifier of the case.</p>
        domain_id: <p>The unique identifier of the Cases domain.</p>
        max_results: <p>The maximum number of audit events to return. When no value is provided, 25 is the default.</p>
        next_token: <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>

    Raises:
        capo_connectcases.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_connectcases.errors.internal_server_exception.InternalServerException: <p>We couldn't process your request because of an issue with the server. Try again later.</p>
        capo_connectcases.errors.resource_not_found_exception.ResourceNotFoundException: <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
        capo_connectcases.errors.throttling_exception.ThrottlingException: <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
        capo_connectcases.errors.validation_exception.ValidationException: <p>The request isn't valid. Check the syntax and try again.</p>
        capo_connectcases.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connectcases.types.get_case_audit_events_request.GetCaseAuditEventsRequest]",
    ) -> OperationResponse[
        "capo_connectcases.types.get_case_audit_events_response.GetCaseAuditEventsResponse"
    ]:
        import capo_connectcases._operations.amazon_connect_cases.get_case_audit_events

        output, http_response = (
            capo_connectcases._operations.amazon_connect_cases.get_case_audit_events.get_case_audit_events(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_connectcases.types.get_case_audit_events_response.GetCaseAuditEventsResponse",
    ) -> dict[str, Any]:
        import capo_connectcases.types.get_case_audit_events_response

        return (
            capo_connectcases.types.get_case_audit_events_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetCaseAuditEvents", redact_output=_redact_output),
    )
    input_: capo_connectcases.types.get_case_audit_events_request.GetCaseAuditEventsRequest = {
        "case_id": case_id,
        "domain_id": domain_id,
    }
    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