ivsrealtimeClient#
Index > ivsrealtime > ivsrealtimeClient
Auto-generated documentation for ivsrealtime type annotations stubs module mypy-boto3-ivs-realtime.
ivsrealtimeClient#
Type annotations and code completion for boto3.client("ivs-realtime").
boto3 documentation
# ivsrealtimeClient usage example
from boto3.session import Session
from mypy_boto3_ivs_realtime.client import ivsrealtimeClient
def get_ivs-realtime_client() -> ivsrealtimeClient:
return Session().client("ivs-realtime")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("ivs-realtime").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("ivs-realtime")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.PendingVerification,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ValidationException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_ivs_realtime.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("ivs-realtime").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("ivs-realtime").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...create_participant_token#
Creates an additional token for a specified stage.
Type annotations and code completion for boto3.client("ivs-realtime").create_participant_token method.
boto3 documentation
# create_participant_token method definition
def create_participant_token(
self,
*,
stageArn: str,
attributes: Mapping[str, str] = ...,
capabilities: Sequence[ParticipantTokenCapabilityType] = ..., # (1)
duration: int = ...,
userId: str = ...,
) -> CreateParticipantTokenResponseTypeDef: # (2)
...# create_participant_token method usage example with argument unpacking
kwargs: CreateParticipantTokenRequestRequestTypeDef = { # (1)
"stageArn": ...,
}
parent.create_participant_token(**kwargs)create_stage#
Creates a new stage (and optionally participant tokens).
Type annotations and code completion for boto3.client("ivs-realtime").create_stage method.
boto3 documentation
# create_stage method definition
def create_stage(
self,
*,
name: str = ...,
participantTokenConfigurations: Sequence[ParticipantTokenConfigurationTypeDef] = ..., # (1)
tags: Mapping[str, str] = ...,
) -> CreateStageResponseTypeDef: # (2)
...# create_stage method usage example with argument unpacking
kwargs: CreateStageRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_stage(**kwargs)delete_stage#
Shuts down and deletes the specified stage (disconnecting all participants).
Type annotations and code completion for boto3.client("ivs-realtime").delete_stage method.
boto3 documentation
# delete_stage method definition
def delete_stage(
self,
*,
arn: str,
) -> Dict[str, Any]:
...# delete_stage method usage example with argument unpacking
kwargs: DeleteStageRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_stage(**kwargs)disconnect_participant#
Disconnects a specified participant and revokes the participant permanently from a specified stage.
Type annotations and code completion for boto3.client("ivs-realtime").disconnect_participant method.
boto3 documentation
# disconnect_participant method definition
def disconnect_participant(
self,
*,
participantId: str,
stageArn: str,
reason: str = ...,
) -> Dict[str, Any]:
...# disconnect_participant method usage example with argument unpacking
kwargs: DisconnectParticipantRequestRequestTypeDef = { # (1)
"participantId": ...,
"stageArn": ...,
}
parent.disconnect_participant(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("ivs-realtime").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...get_participant#
Gets information about the specified participant token.
Type annotations and code completion for boto3.client("ivs-realtime").get_participant method.
boto3 documentation
# get_participant method definition
def get_participant(
self,
*,
participantId: str,
sessionId: str,
stageArn: str,
) -> GetParticipantResponseTypeDef: # (1)
...# get_participant method usage example with argument unpacking
kwargs: GetParticipantRequestRequestTypeDef = { # (1)
"participantId": ...,
"sessionId": ...,
"stageArn": ...,
}
parent.get_participant(**kwargs)get_stage#
Gets information for the specified stage.
Type annotations and code completion for boto3.client("ivs-realtime").get_stage method.
boto3 documentation
# get_stage method definition
def get_stage(
self,
*,
arn: str,
) -> GetStageResponseTypeDef: # (1)
...# get_stage method usage example with argument unpacking
kwargs: GetStageRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_stage(**kwargs)get_stage_session#
Gets information for the specified stage session.
Type annotations and code completion for boto3.client("ivs-realtime").get_stage_session method.
boto3 documentation
# get_stage_session method definition
def get_stage_session(
self,
*,
sessionId: str,
stageArn: str,
) -> GetStageSessionResponseTypeDef: # (1)
...# get_stage_session method usage example with argument unpacking
kwargs: GetStageSessionRequestRequestTypeDef = { # (1)
"sessionId": ...,
"stageArn": ...,
}
parent.get_stage_session(**kwargs)list_participant_events#
Lists events for a specified participant that occurred during a specified stage session.
Type annotations and code completion for boto3.client("ivs-realtime").list_participant_events method.
boto3 documentation
# list_participant_events method definition
def list_participant_events(
self,
*,
participantId: str,
sessionId: str,
stageArn: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListParticipantEventsResponseTypeDef: # (1)
...# list_participant_events method usage example with argument unpacking
kwargs: ListParticipantEventsRequestRequestTypeDef = { # (1)
"participantId": ...,
"sessionId": ...,
"stageArn": ...,
}
parent.list_participant_events(**kwargs)list_participants#
Lists all participants in a specified stage session.
Type annotations and code completion for boto3.client("ivs-realtime").list_participants method.
boto3 documentation
# list_participants method definition
def list_participants(
self,
*,
sessionId: str,
stageArn: str,
filterByPublished: bool = ...,
filterByState: ParticipantStateType = ..., # (1)
filterByUserId: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListParticipantsResponseTypeDef: # (2)
...# list_participants method usage example with argument unpacking
kwargs: ListParticipantsRequestRequestTypeDef = { # (1)
"sessionId": ...,
"stageArn": ...,
}
parent.list_participants(**kwargs)list_stage_sessions#
Gets all sessions for a specified stage.
Type annotations and code completion for boto3.client("ivs-realtime").list_stage_sessions method.
boto3 documentation
# list_stage_sessions method definition
def list_stage_sessions(
self,
*,
stageArn: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListStageSessionsResponseTypeDef: # (1)
...# list_stage_sessions method usage example with argument unpacking
kwargs: ListStageSessionsRequestRequestTypeDef = { # (1)
"stageArn": ...,
}
parent.list_stage_sessions(**kwargs)list_stages#
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
Type annotations and code completion for boto3.client("ivs-realtime").list_stages method.
boto3 documentation
# list_stages method definition
def list_stages(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListStagesResponseTypeDef: # (1)
...# list_stages method usage example with argument unpacking
kwargs: ListStagesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_stages(**kwargs)list_tags_for_resource#
Gets information about AWS tags for the specified ARN.
Type annotations and code completion for boto3.client("ivs-realtime").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)tag_resource#
Adds or updates tags for the AWS resource with the specified ARN.
Type annotations and code completion for boto3.client("ivs-realtime").tag_resource method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
Removes tags from the resource with the specified ARN.
Type annotations and code completion for boto3.client("ivs-realtime").untag_resource method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)update_stage#
Updates a stage’s configuration.
Type annotations and code completion for boto3.client("ivs-realtime").update_stage method.
boto3 documentation
# update_stage method definition
def update_stage(
self,
*,
arn: str,
name: str = ...,
) -> UpdateStageResponseTypeDef: # (1)
...# update_stage method usage example with argument unpacking
kwargs: UpdateStageRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.update_stage(**kwargs)