Gets information about the specified participant token.
Parameters:
Raises:
Source code in docs_src/capo_ivs_realtime/_services/ivs_real_time.py
| def get_participant(
self,
stage_arn: "capo_ivs_realtime.types.stage_arn.StageArn",
session_id: "capo_ivs_realtime.types.stage_session_id.StageSessionId",
participant_id: "capo_ivs_realtime.types.participant_id.ParticipantId",
*,
config_overrides: Optional[IVSRealTimeClientConfig] = None,
) -> "capo_ivs_realtime.types.get_participant_response.GetParticipantResponse":
"""<p>Gets information about the specified participant token.</p>
Args:
stage_arn: <p>Stage ARN.</p>
session_id: <p>ID of a session within the stage.</p>
participant_id: <p>Unique identifier for the participant. This is assigned by IVS and returned by <a>CreateParticipantToken</a>.</p>
Raises:
capo_ivs_realtime.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
capo_ivs_realtime.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
capo_ivs_realtime.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
capo_ivs_realtime.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_ivs_realtime.types.get_participant_request.GetParticipantRequest]",
) -> OperationResponse[
"capo_ivs_realtime.types.get_participant_response.GetParticipantResponse"
]:
import capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.get_participant
output, http_response = (
capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.get_participant.get_participant(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetParticipant")
)
input_: capo_ivs_realtime.types.get_participant_request.GetParticipantRequest = {
"stage_arn": stage_arn,
"session_id": session_id,
"participant_id": participant_id,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|