Skip to content

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_encoder_configuration#

Creates an EncoderConfiguration object.

Type annotations and code completion for boto3.client("ivs-realtime").create_encoder_configuration method. boto3 documentation

# create_encoder_configuration method definition

def create_encoder_configuration(
    self,
    *,
    name: str = ...,
    video: VideoTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateEncoderConfigurationResponseTypeDef:  # (2)
    ...
  1. See VideoTypeDef
  2. See CreateEncoderConfigurationResponseTypeDef
# create_encoder_configuration method usage example with argument unpacking

kwargs: CreateEncoderConfigurationRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_encoder_configuration(**kwargs)
  1. See CreateEncoderConfigurationRequestRequestTypeDef

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,
    duration: int = ...,
    userId: str = ...,
    attributes: Mapping[str, str] = ...,
    capabilities: Sequence[ParticipantTokenCapabilityType] = ...,  # (1)
) -> CreateParticipantTokenResponseTypeDef:  # (2)
    ...
  1. See ParticipantTokenCapabilityType
  2. See CreateParticipantTokenResponseTypeDef
# create_participant_token method usage example with argument unpacking

kwargs: CreateParticipantTokenRequestRequestTypeDef = {  # (1)
    "stageArn": ...,
}

parent.create_participant_token(**kwargs)
  1. See CreateParticipantTokenRequestRequestTypeDef

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] = ...,
    autoParticipantRecordingConfiguration: Union[AutoParticipantRecordingConfigurationTypeDef, AutoParticipantRecordingConfigurationOutputTypeDef] = ...,  # (2)
) -> CreateStageResponseTypeDef:  # (3)
    ...
  1. See ParticipantTokenConfigurationTypeDef
  2. See AutoParticipantRecordingConfigurationTypeDef AutoParticipantRecordingConfigurationOutputTypeDef
  3. See CreateStageResponseTypeDef
# create_stage method usage example with argument unpacking

kwargs: CreateStageRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_stage(**kwargs)
  1. See CreateStageRequestRequestTypeDef

create_storage_configuration#

Creates a new storage configuration, used to enable recording to Amazon S3.

Type annotations and code completion for boto3.client("ivs-realtime").create_storage_configuration method. boto3 documentation

# create_storage_configuration method definition

def create_storage_configuration(
    self,
    *,
    s3: S3StorageConfigurationTypeDef,  # (1)
    name: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateStorageConfigurationResponseTypeDef:  # (2)
    ...
  1. See S3StorageConfigurationTypeDef
  2. See CreateStorageConfigurationResponseTypeDef
# create_storage_configuration method usage example with argument unpacking

kwargs: CreateStorageConfigurationRequestRequestTypeDef = {  # (1)
    "s3": ...,
}

parent.create_storage_configuration(**kwargs)
  1. See CreateStorageConfigurationRequestRequestTypeDef

delete_encoder_configuration#

Deletes an EncoderConfiguration resource.

Type annotations and code completion for boto3.client("ivs-realtime").delete_encoder_configuration method. boto3 documentation

# delete_encoder_configuration method definition

def delete_encoder_configuration(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...
# delete_encoder_configuration method usage example with argument unpacking

kwargs: DeleteEncoderConfigurationRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_encoder_configuration(**kwargs)
  1. See DeleteEncoderConfigurationRequestRequestTypeDef

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)
  1. See DeleteStageRequestRequestTypeDef

delete_storage_configuration#

Deletes the storage configuration for the specified ARN.

Type annotations and code completion for boto3.client("ivs-realtime").delete_storage_configuration method. boto3 documentation

# delete_storage_configuration method definition

def delete_storage_configuration(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...
# delete_storage_configuration method usage example with argument unpacking

kwargs: DeleteStorageConfigurationRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_storage_configuration(**kwargs)
  1. See DeleteStorageConfigurationRequestRequestTypeDef

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,
    *,
    stageArn: str,
    participantId: str,
    reason: str = ...,
) -> Dict[str, Any]:
    ...
# disconnect_participant method usage example with argument unpacking

kwargs: DisconnectParticipantRequestRequestTypeDef = {  # (1)
    "stageArn": ...,
    "participantId": ...,
}

parent.disconnect_participant(**kwargs)
  1. See DisconnectParticipantRequestRequestTypeDef

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_composition#

Get information about the specified Composition resource.

Type annotations and code completion for boto3.client("ivs-realtime").get_composition method. boto3 documentation

# get_composition method definition

def get_composition(
    self,
    *,
    arn: str,
) -> GetCompositionResponseTypeDef:  # (1)
    ...
  1. See GetCompositionResponseTypeDef
# get_composition method usage example with argument unpacking

kwargs: GetCompositionRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_composition(**kwargs)
  1. See GetCompositionRequestRequestTypeDef

get_encoder_configuration#

Gets information about the specified EncoderConfiguration resource.

Type annotations and code completion for boto3.client("ivs-realtime").get_encoder_configuration method.