IvsrealtimeClient

Index > Ivsrealtime > IvsrealtimeClient

Auto-generated documentation for Ivsrealtime type annotations stubs module types-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 types_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 types_boto3_ivs_realtime.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

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:
    ...

generate_presigned_url

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:
    ...

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: CreateEncoderConfigurationRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_encoder_configuration(**kwargs)

1. See CreateEncoderConfigurationRequestTypeDef

create_ingest_configuration

Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.

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

# create_ingest_configuration method definition

def create_ingest_configuration(
    self,
    *,
    ingestProtocol: IngestProtocolType,  # (1)
    name: str = ...,
    stageArn: str = ...,
    userId: str = ...,
    attributes: Mapping[str, str] = ...,
    insecureIngest: bool = ...,
    tags: Mapping[str, str] = ...,
) -> CreateIngestConfigurationResponseTypeDef:  # (2)
    ...

1. See IngestProtocolType
2. See CreateIngestConfigurationResponseTypeDef

# create_ingest_configuration method usage example with argument unpacking

kwargs: CreateIngestConfigurationRequestTypeDef = {  # (1)
    "ingestProtocol": ...,
}

parent.create_ingest_configuration(**kwargs)

1. See CreateIngestConfigurationRequestTypeDef

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 Sequence[ParticipantTokenCapabilityType]
2. See CreateParticipantTokenResponseTypeDef

# create_participant_token method usage example with argument unpacking

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

parent.create_participant_token(**kwargs)

1. See CreateParticipantTokenRequestTypeDef

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: AutoParticipantRecordingConfigurationUnionTypeDef = ...,  # (2)
) -> CreateStageResponseTypeDef:  # (3)
    ...

1. See Sequence[ParticipantTokenConfigurationTypeDef]
2. See AutoParticipantRecordingConfigurationUnionTypeDef
3. See CreateStageResponseTypeDef

# create_stage method usage example with argument unpacking

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

parent.create_stage(**kwargs)

1. See CreateStageRequestTypeDef

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: CreateStorageConfigurationRequestTypeDef = {  # (1)
    "s3": ...,
}

parent.create_storage_configuration(**kwargs)

1. See CreateStorageConfigurationRequestTypeDef

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: DeleteEncoderConfigurationRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_encoder_configuration(**kwargs)

1. See DeleteEncoderConfigurationRequestTypeDef

delete_ingest_configuration

Deletes a specified IngestConfiguration, so it can no longer be used to broadcast.

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

# delete_ingest_configuration method definition

def delete_ingest_configuration(
    self,
    *,
    arn: str,
    force: bool = ...,
) -> Dict[str, Any]:
    ...

# delete_ingest_configuration method usage example with argument unpacking

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

parent.delete_ingest_configuration(**kwargs)

1. See DeleteIngestConfigurationRequestTypeDef

delete_public_key

Deletes the specified public key used to sign stage participant tokens.

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

# delete_public_key method definition

def delete_public_key(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

# delete_public_key method usage example with argument unpacking

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

parent.delete_public_key(**kwargs)

1. See DeletePublicKeyRequestTypeDef

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: DeleteStageRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_stage(**kwargs)

1. See DeleteStageRequestTypeDef

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: DeleteStorageConfigurationRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_storage_configuration(**kwargs)

1. See DeleteStorageConfigurationRequestTypeDef

disconnect_participant

Disconnects a specified participant 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: DisconnectParticipantRequestTypeDef = {  # (1)
    "stageArn": ...,
    "participantId": ...,
}

parent.disconnect_participant(**kwargs)

1. See DisconnectParticipantRequestTypeDef

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: GetCompositionRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_composition(**kwargs)

1. See GetCompositionRequestTypeDef

get_encoder_configuration

Gets information about the specified EncoderConfiguration resource.

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

# get_encoder_configuration method definition

def get_encoder_configuration(
    self,
    *,
    arn: str,
) -> GetEncoderConfigurationResponseTypeDef:  # (1)
    ...

1. See GetEncoderConfigurationResponseTypeDef

# get_encoder_configuration method usage example with argument unpacking

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

parent.get_encoder_configuration(**kwargs)

1. See GetEncoderConfigurationRequestTypeDef

get_ingest_configuration

Gets information about the specified IngestConfiguration.

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

# get_ingest_configuration method definition

def get_ingest_configuration(
    self,
    *,
    arn: str,
) -> GetIngestConfigurationResponseTypeDef:  # (1)
    ...

1. See GetIngestConfigurationResponseTypeDef

# get_ingest_configuration method usage example with argument unpacking

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

parent.get_ingest_configuration(**kwargs)

1. See GetIngestConfigurationRequestTypeDef

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,
    *,
    stageArn: str,
    sessionId: str,
    participantId: str,
) -> GetParticipantResponseTypeDef:  # (1)
    ...

1. See GetParticipantResponseTypeDef

# get_participant method usage example with argument unpacking

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

parent.get_participant(**kwargs)

1. See GetParticipantRequestTypeDef

get_public_key

Gets information for the specified public key.

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

# get_public_key method definition

def get_public_key(
    self,
    *,
    arn: str,
) -> GetPublicKeyResponseTypeDef:  # (1)
    ...

1. See GetPublicKeyResponseTypeDef

# get_public_key method usage example with argument unpacking

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

parent.get_public_key(**kwargs)

1. See GetPublicKeyRequestTypeDef

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)
    ...

1. See GetStageResponseTypeDef

# get_stage method usage example with argument unpacking

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

parent.get_stage(**kwargs)

1. See GetStageRequestTypeDef

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,
    *,
    stageArn: str,
    sessionId: str,
) -> GetStageSessionResponseTypeDef:  # (1)
    ...

1. See GetStageSessionResponseTypeDef

# get_stage_session method usage example with argument unpacking

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

parent.get_stage_session(**kwargs)

1. See GetStageSessionRequestTypeDef

get_storage_configuration

Gets the storage configuration for the specified ARN.

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

# get_storage_configuration method definition

def get_storage_configuration(
    self,
    *,
    arn: str,
) -> GetStorageConfigurationResponseTypeDef:  # (1)
    ...

1. See GetStorageConfigurationResponseTypeDef

# get_storage_configuration method usage example with argument unpacking

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

parent.get_storage_configuration(**kwargs)

1. See GetStorageConfigurationRequestTypeDef

import_public_key

Import a public key to be used for signing stage participant tokens.

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

# import_public_key method definition

def import_public_key(
    self,
    *,
    publicKeyMaterial: str,
    name: str = ...,
    tags: Mapping[str, str] = ...,
) -> ImportPublicKeyResponseTypeDef:  # (1)
    ...

1. See ImportPublicKeyResponseTypeDef

# import_public_key method usage example with argument unpacking

kwargs: ImportPublicKeyRequestTypeDef = {  # (1)
    "publicKeyMaterial": ...,
}

parent.import_public_key(**kwargs)

1. See ImportPublicKeyRequestTypeDef

list_compositions

Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.

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

# list_compositions method definition

def list_compositions(
    self,
    *,
    filterByStageArn: str = ...,
    filterByEncoderConfigurationArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListCompositionsResponseTypeDef:  # (1)
    ...

1. See ListCompositionsResponseTypeDef

# list_compositions method usage example with argument unpacking

kwargs: ListCompositionsRequestTypeDef = {  # (1)
    "filterByStageArn": ...,
}

parent.list_compositions(**kwargs)

1. See ListCompositionsRequestTypeDef

list_encoder_configurations

Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.

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

# list_encoder_configurations method definition

def list_encoder_configurations(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListEncoderConfigurationsResponseTypeDef:  # (1)
    ...

1. See ListEncoderConfigurationsResponseTypeDef

# list_encoder_configurations method usage example with argument unpacking

kwargs: ListEncoderConfigurationsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_encoder_configurations(**kwargs)

1. See ListEncoderConfigurationsRequestTypeDef

list_ingest_configurations

Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.

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

# list_ingest_configurations method definition

def list_ingest_configurations(
    self,
    *,
    filterByStageArn: str = ...,
    filterByState: IngestConfigurationStateType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListIngestConfigurationsResponseTypeDef:  # (2)
    ...

1. See IngestConfigurationStateType
2. See ListIngestConfigurationsResponseTypeDef

# list_ingest_configurations method usage example with argument unpacking

kwargs: ListIngestConfigurationsRequestTypeDef = {  # (1)
    "filterByStageArn": ...,
}

parent.list_ingest_configurations(**kwargs)

1. See ListIngestConfigurationsRequestTypeDef

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,
    *,
    stageArn: str,
    sessionId: str,
    participantId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListParticipantEventsResponseTypeDef:  # (1)
    ...

1. See ListParticipantEventsResponseTypeDef

# list_participant_events method usage example with argument unpacking

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

parent.list_participant_events(**kwargs)

1. See ListParticipantEventsRequestTypeDef

list_participant_replicas

Lists all the replicas for a participant from a source stage.

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

# list_participant_replicas method definition

def list_participant_replicas(
    self,
    *,
    sourceStageArn: str,
    participantId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListParticipantReplicasResponseTypeDef:  # (1)
    ...

1. See ListParticipantReplicasResponseTypeDef

# list_participant_replicas method usage example with argument unpacking

kwargs: ListParticipantReplicasRequestTypeDef = {  # (1)
    "sourceStageArn": ...,
    "participantId": ...,
}

parent.list_participant_replicas(**kwargs)

1. See ListParticipantReplicasRequestTypeDef

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,
    *,
    stageArn: str,
    sessionId: str,
    filterByUserId: str = ...,
    filterByPublished: bool = ...,
    filterByState: ParticipantStateType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
    filterByRecordingState: ParticipantRecordingFilterByRecordingStateType = ...,  # (2)
) -> ListParticipantsResponseTypeDef:  # (3)
    ...

1. See ParticipantStateType
2. See ParticipantRecordingFilterByRecordingStateType
3. See ListParticipantsResponseTypeDef

# list_participants method usage example with argument unpacking

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

parent.list_participants(**kwargs)

1. See ListParticipantsRequestTypeDef

list_public_keys

Gets summary information about all public keys in your account, in the AWS region where the API request is processed.

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

# list_public_keys method definition

def list_public_keys(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPublicKeysResponseTypeDef:  # (1)
    ...

1. See ListPublicKeysResponseTypeDef

# list_public_keys method usage example with argument unpacking

kwargs: ListPublicKeysRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_public_keys(**kwargs)

1. See ListPublicKeysRequestTypeDef

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,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListStageSessionsResponseTypeDef:  # (1)
    ...

1. See ListStageSessionsResponseTypeDef

# list_stage_sessions method usage example with argument unpacking

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

parent.list_stage_sessions(**kwargs)

1. See ListStageSessionsRequestTypeDef

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,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListStagesResponseTypeDef:  # (1)
    ...

1. See ListStagesResponseTypeDef

# list_stages method usage example with argument unpacking

kwargs: ListStagesRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_stages(**kwargs)

1. See ListStagesRequestTypeDef

list_storage_configurations

Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.

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

# list_storage_configurations method definition

def list_storage_configurations(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListStorageConfigurationsResponseTypeDef:  # (1)
    ...

1. See ListStorageConfigurationsResponseTypeDef

# list_storage_configurations method usage example with argument unpacking

kwargs: ListStorageConfigurationsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_storage_configurations(**kwargs)

1. See ListStorageConfigurationsRequestTypeDef

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)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

start_composition

Starts a Composition from a stage based on the configuration provided in the request.

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

# start_composition method definition

def start_composition(
    self,
    *,
    stageArn: str,
    destinations: Sequence[DestinationConfigurationUnionTypeDef],  # (1)
    idempotencyToken: str = ...,
    layout: LayoutConfigurationTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
) -> StartCompositionResponseTypeDef:  # (3)
    ...

1. See Sequence[DestinationConfigurationUnionTypeDef]
2. See LayoutConfigurationTypeDef
3. See StartCompositionResponseTypeDef

# start_composition method usage example with argument unpacking

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

parent.start_composition(**kwargs)

1. See StartCompositionRequestTypeDef

start_participant_replication

Starts replicating a publishing participant from a source stage to a destination stage.

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

# start_participant_replication method definition

def start_participant_replication(
    self,
    *,
    sourceStageArn: str,
    destinationStageArn: str,
    participantId: str,
    reconnectWindowSeconds: int = ...,
    attributes: Mapping[str, str] = ...,
) -> StartParticipantReplicationResponseTypeDef:  # (1)
    ...

1. See StartParticipantReplicationResponseTypeDef

# start_participant_replication method usage example with argument unpacking

kwargs: StartParticipantReplicationRequestTypeDef = {  # (1)
    "sourceStageArn": ...,
    "destinationStageArn": ...,
    "participantId": ...,
}

parent.start_participant_replication(**kwargs)

1. See StartParticipantReplicationRequestTypeDef

stop_composition

Stops and deletes a Composition resource.

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

# stop_composition method definition

def stop_composition(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

# stop_composition method usage example with argument unpacking

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

parent.stop_composition(**kwargs)

1. See StopCompositionRequestTypeDef

stop_participant_replication

Stops a replicated participant session.

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

# stop_participant_replication method definition

def stop_participant_replication(
    self,
    *,
    sourceStageArn: str,
    destinationStageArn: str,
    participantId: str,
) -> StopParticipantReplicationResponseTypeDef:  # (1)
    ...

1. See StopParticipantReplicationResponseTypeDef

# stop_participant_replication method usage example with argument unpacking

kwargs: StopParticipantReplicationRequestTypeDef = {  # (1)
    "sourceStageArn": ...,
    "destinationStageArn": ...,
    "participantId": ...,
}

parent.stop_participant_replication(**kwargs)

1. See StopParticipantReplicationRequestTypeDef

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: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

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: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_ingest_configuration

Updates a specified IngestConfiguration.

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

# update_ingest_configuration method definition

def update_ingest_configuration(
    self,
    *,
    arn: str,
    stageArn: str = ...,
) -> UpdateIngestConfigurationResponseTypeDef:  # (1)
    ...

1. See UpdateIngestConfigurationResponseTypeDef

# update_ingest_configuration method usage example with argument unpacking

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

parent.update_ingest_configuration(**kwargs)

1. See UpdateIngestConfigurationRequestTypeDef

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 = ...,
    autoParticipantRecordingConfiguration: AutoParticipantRecordingConfigurationUnionTypeDef = ...,  # (1)
) -> UpdateStageResponseTypeDef:  # (2)
    ...

1. See AutoParticipantRecordingConfigurationUnionTypeDef
2. See UpdateStageResponseTypeDef

# update_stage method usage example with argument unpacking

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

parent.update_stage(**kwargs)

1. See UpdateStageRequestTypeDef

get_paginator

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

• client.get_paginator("list_ingest_configurations") -> ListIngestConfigurationsPaginator
• client.get_paginator("list_participant_replicas") -> ListParticipantReplicasPaginator
• client.get_paginator("list_public_keys") -> ListPublicKeysPaginator