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, orSearchEvents. -
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, andfieldListmembers 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
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 | |