batch_get_event
async
¶
batch_get_event(
space_id: SpaceId,
event_ids: BatchGetEventIdList,
*,
config_overrides: Optional[AsyncOpenSearchMemoryClientConfig] = None,
actor_id: Optional[ActorId] = None,
session_id: Optional[SessionId] = None,
) -> BatchGetEventOutput
Gets up to 10 events by ID, each as GetEvent returns it, including its payload.
If you supply actorId or sessionId, every requested event must match it. Each event has its own outcome. The operation reports an event that it can't return in errors instead of failing, with an error code named for the exception that GetEvent would return for it. The operation reports both an event that doesn't exist and an event outside the supplied scope as RESOURCE_NOT_FOUND.
The exception is the space's customer managed AWS KMS key: if it is disabled, pending deletion, can't be used for decryption, or was deleted, the whole call fails with ValidationException, as GetEvent does.
Parameters:
-
space_id(SpaceId) –The ID of the space.
-
actor_id(Optional[ActorId], default:None) –The actor that every requested event must belong to. Omit it to skip this check. The operation reports an event that doesn't match in
errorsasRESOURCE_NOT_FOUND. -
session_id(Optional[SessionId], default:None) –The session that every requested event must belong to. Omit it to skip this check. The operation reports an event that doesn't match in
errorsasRESOURCE_NOT_FOUND. -
event_ids(BatchGetEventIdList) –The IDs of the events to get: 1 to 10, without duplicates.
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, andfieldListmembers describe the problem. Fix the request, and then try again. -
UnknownServiceError–The service returned an error code this client does not model.