Skip to content

get_event

get_event(
    space_id: SpaceId,
    event_id: EventId,
    *,
    config_overrides: Optional[OpenSearchMemoryClientConfig] = None,
    actor_id: Optional[ActorId] = None,
    session_id: Optional[SessionId] = None,
) -> GetEventOutput

Gets an event by ID, including its payload.

If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with AccessDeniedException if you aren't allowed to use the key, and with ThrottlingException if AWS KMS throttles the request. It fails with ValidationException if the key is disabled, pending deletion, or deleted.

Parameters:

  • space_id (SpaceId) –

    The ID of the space.

  • event_id (EventId) –

    The event's ID, as returned by CreateEvent, ListEvents, or SearchEvents.

  • actor_id (Optional[ActorId], default: None ) –

    The actor the event must belong to. Omit it to skip this check. If it doesn't match the stored event, the call fails with ResourceNotFoundException, as if the event did not exist.

  • session_id (Optional[SessionId], default: None ) –

    The session the event must belong to. Omit it to skip this check. If it doesn't match the stored event, the call fails with ResourceNotFoundException, as if the event did not exist.

Raises:

  • AccessDeniedException –

    You don't have sufficient access to perform this operation. To use this operation, you must have AWS Identity and Access Management (IAM) permissions for the operation, and on the resource it acts on. If the space uses a customer managed AWS Key Management Service (AWS KMS) key, you must also have permission to use the key.

  • InternalServerException –

    The service couldn't process the request because of an internal error. Retry the request.

  • ResourceNotFoundException –

    The specified resource doesn't exist. Check the IDs in the request.

  • ThrottlingException –

    The service throttled the request. Retry the request with exponential backoff.

  • ValidationException –

    The request isn't valid. The reason, message, and fieldList members describe the problem. Fix the request, and then try again.

  • UnknownServiceError –

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

Source code in docs_src/capo_opensearchmemory/_services/open_search_memory.py
def get_event(
    self,
    space_id: "capo_opensearchmemory.types.space_id.SpaceId",
    event_id: "capo_opensearchmemory.types.event_id.EventId",
    *,
    config_overrides: Optional[OpenSearchMemoryClientConfig] = None,
    actor_id: Optional["capo_opensearchmemory.types.actor_id.ActorId"] = None,
    session_id: Optional["capo_opensearchmemory.types.session_id.SessionId"] = None,
) -> "capo_opensearchmemory.types.get_event_output.GetEventOutput":
    """<p>Gets an event by ID, including its payload.</p> <p>If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with <code>AccessDeniedException</code> if you aren't allowed to use the key, and with <code>ThrottlingException</code> if AWS KMS throttles the request. It fails with <code>ValidationException</code> if the key is disabled, pending deletion, or deleted.</p>

    Args:
        space_id: <p>The ID of the space.</p>
        event_id: <p>The event's ID, as returned by <code>CreateEvent</code>, <code>ListEvents</code>, or <code>SearchEvents</code>.</p>
        actor_id: <p>The actor the event must belong to. Omit it to skip this check. If it doesn't match the stored event, the call fails with <code>ResourceNotFoundException</code>, as if the event did not exist.</p>
        session_id: <p>The session the event must belong to. Omit it to skip this check. If it doesn't match the stored event, the call fails with <code>ResourceNotFoundException</code>, as if the event did not exist.</p>

    Raises:
        capo_opensearchmemory.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this operation. To use this operation, you must have AWS Identity and Access Management (IAM) permissions for the operation, and on the resource it acts on. If the space uses a customer managed AWS Key Management Service (AWS KMS) key, you must also have permission to use the key.</p>
        capo_opensearchmemory.errors.internal_server_exception.InternalServerException: <p>The service couldn't process the request because of an internal error. Retry the request.</p>
        capo_opensearchmemory.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource doesn't exist. Check the IDs in the request.</p>
        capo_opensearchmemory.errors.throttling_exception.ThrottlingException: <p>The service throttled the request. Retry the request with exponential backoff.</p>
        capo_opensearchmemory.errors.validation_exception.ValidationException: <p>The request isn't valid. The <code>reason</code>, <code>message</code>, and <code>fieldList</code> members describe the problem. Fix the request, and then try again.</p>
        capo_opensearchmemory.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_opensearchmemory.types.get_event_input.GetEventInput]",
    ) -> OperationResponse[
        "capo_opensearchmemory.types.get_event_output.GetEventOutput"
    ]:
        import capo_opensearchmemory._operations.open_search_memory.get_event

        output, http_response = (
            capo_opensearchmemory._operations.open_search_memory.get_event.get_event(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_opensearchmemory.types.get_event_output.GetEventOutput",
    ) -> dict[str, Any]:
        import capo_opensearchmemory.types.get_event_output

        return capo_opensearchmemory.types.get_event_output.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetEvent", redact_output=_redact_output)
    )
    input_: capo_opensearchmemory.types.get_event_input.GetEventInput = {
        "space_id": space_id,
        "event_id": event_id,
    }
    if actor_id is not None:
        input_["actor_id"] = actor_id
    if session_id is not None:
        input_["session_id"] = session_id

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