Skip to content

IVSClient#

Index > IVS > IVSClient

Auto-generated documentation for IVS type annotations stubs module mypy-boto3-ivs.

IVSClient#

Type annotations and code completion for boto3.client("ivs"). boto3 documentation

# IVSClient usage example

from boto3.session import Session
from mypy_boto3_ivs.client import IVSClient

def get_ivs_client() -> IVSClient:
    return Session().client("ivs")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("ivs").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("ivs")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ChannelNotBroadcasting,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.PendingVerification,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.StreamUnavailable,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_ivs.client import Exceptions

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

Methods#

batch_get_channel#

Performs GetChannel on multiple ARNs simultaneously.

Type annotations and code completion for boto3.client("ivs").batch_get_channel method. boto3 documentation

# batch_get_channel method definition

def batch_get_channel(
    self,
    *,
    arns: Sequence[str],
) -> BatchGetChannelResponseTypeDef:  # (1)
    ...
  1. See BatchGetChannelResponseTypeDef
# batch_get_channel method usage example with argument unpacking

kwargs: BatchGetChannelRequestRequestTypeDef = {  # (1)
    "arns": ...,
}

parent.batch_get_channel(**kwargs)
  1. See BatchGetChannelRequestRequestTypeDef

batch_get_stream_key#

Performs GetStreamKey on multiple ARNs simultaneously.

Type annotations and code completion for boto3.client("ivs").batch_get_stream_key method. boto3 documentation

# batch_get_stream_key method definition

def batch_get_stream_key(
    self,
    *,
    arns: Sequence[str],
) -> BatchGetStreamKeyResponseTypeDef:  # (1)
    ...
  1. See BatchGetStreamKeyResponseTypeDef
# batch_get_stream_key method usage example with argument unpacking

kwargs: BatchGetStreamKeyRequestRequestTypeDef = {  # (1)
    "arns": ...,
}

parent.batch_get_stream_key(**kwargs)
  1. See BatchGetStreamKeyRequestRequestTypeDef

batch_start_viewer_session_revocation#

Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.

Type annotations and code completion for boto3.client("ivs").batch_start_viewer_session_revocation method. boto3 documentation

# batch_start_viewer_session_revocation method definition

def batch_start_viewer_session_revocation(
    self,
    *,
    viewerSessions: Sequence[BatchStartViewerSessionRevocationViewerSessionTypeDef],  # (1)
) -> BatchStartViewerSessionRevocationResponseTypeDef:  # (2)
    ...
  1. See BatchStartViewerSessionRevocationViewerSessionTypeDef
  2. See BatchStartViewerSessionRevocationResponseTypeDef
# batch_start_viewer_session_revocation method usage example with argument unpacking

kwargs: BatchStartViewerSessionRevocationRequestRequestTypeDef = {  # (1)
    "viewerSessions": ...,
}

parent.batch_start_viewer_session_revocation(**kwargs)
  1. See BatchStartViewerSessionRevocationRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("ivs").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").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_channel#

Creates a new channel and an associated stream key to start streaming.

Type annotations and code completion for boto3.client("ivs").create_channel method. boto3 documentation

# create_channel method definition

def create_channel(
    self,
    *,
    authorized: bool = ...,
    insecureIngest: bool = ...,
    latencyMode: ChannelLatencyModeType = ...,  # (1)
    name: str = ...,
    playbackRestrictionPolicyArn: str = ...,
    preset: TranscodePresetType = ...,  # (2)
    recordingConfigurationArn: str = ...,
    tags: Mapping[str, str] = ...,
    type: ChannelTypeType = ...,  # (3)
) -> CreateChannelResponseTypeDef:  # (4)
    ...
  1. See ChannelLatencyModeType
  2. See TranscodePresetType
  3. See ChannelTypeType
  4. See CreateChannelResponseTypeDef
# create_channel method usage example with argument unpacking

kwargs: CreateChannelRequestRequestTypeDef = {  # (1)
    "authorized": ...,
}

parent.create_channel(**kwargs)
  1. See CreateChannelRequestRequestTypeDef

create_playback_restriction_policy#

Creates a new playback restriction policy, for constraining playback by countries and/or origins.

Type annotations and code completion for boto3.client("ivs").create_playback_restriction_policy method. boto3 documentation

# create_playback_restriction_policy method definition

def create_playback_restriction_policy(
    self,
    *,
    allowedCountries: Sequence[str] = ...,
    allowedOrigins: Sequence[str] = ...,
    enableStrictOriginEnforcement: bool = ...,
    name: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreatePlaybackRestrictionPolicyResponseTypeDef:  # (1)
    ...
  1. See CreatePlaybackRestrictionPolicyResponseTypeDef
# create_playback_restriction_policy method usage example with argument unpacking

kwargs: CreatePlaybackRestrictionPolicyRequestRequestTypeDef = {  # (1)
    "allowedCountries": ...,
}

parent.create_playback_restriction_policy(**kwargs)
  1. See CreatePlaybackRestrictionPolicyRequestRequestTypeDef

create_recording_configuration#

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

Type annotations and code completion for boto3.client("ivs").create_recording_configuration method. boto3 documentation

# create_recording_configuration method definition

def create_recording_configuration(
    self,
    *,
    destinationConfiguration: DestinationConfigurationTypeDef,  # (1)
    name: str = ...,
    recordingReconnectWindowSeconds: int = ...,
    renditionConfiguration: Union[RenditionConfigurationTypeDef, RenditionConfigurationOutputTypeDef] = ...,  # (2)
    tags: Mapping[str, str] = ...,
    thumbnailConfiguration: Union[ThumbnailConfigurationTypeDef, ThumbnailConfigurationOutputTypeDef] = ...,  # (3)
) -> CreateRecordingConfigurationResponseTypeDef:  # (4)
    ...
  1. See DestinationConfigurationTypeDef
  2. See RenditionConfigurationTypeDef RenditionConfigurationOutputTypeDef
  3. See ThumbnailConfigurationTypeDef ThumbnailConfigurationOutputTypeDef
  4. See CreateRecordingConfigurationResponseTypeDef
# create_recording_configuration method usage example with argument unpacking

kwargs: CreateRecordingConfigurationRequestRequestTypeDef = {  # (1)
    "destinationConfiguration": ...,
}

parent.create_recording_configuration(**kwargs)
  1. See CreateRecordingConfigurationRequestRequestTypeDef

create_stream_key#

Creates a stream key, used to initiate a stream, for the specified channel ARN.

Type annotations and code completion for boto3.client("ivs").create_stream_key method. boto3 documentation

# create_stream_key method definition

def create_stream_key(
    self,
    *,
    channelArn: str,
    tags: Mapping[str, str] = ...,
) -> CreateStreamKeyResponseTypeDef:  # (1)
    ...
  1. See CreateStreamKeyResponseTypeDef
# create_stream_key method usage example with argument unpacking

kwargs: CreateStreamKeyRequestRequestTypeDef = {  # (1)
    "channelArn": ...,
}

parent.create_stream_key(**kwargs)
  1. See CreateStreamKeyRequestRequestTypeDef

delete_channel#

Deletes the specified channel and its associated stream keys.

Type annotations and code completion for boto3.client("ivs").delete_channel method. boto3 documentation

# delete_channel method definition

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

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

parent.delete_channel(**kwargs)
  1. See DeleteChannelRequestRequestTypeDef

delete_playback_key_pair#

Deletes a specified authorization key pair.

Type annotations and code completion for boto3.client("ivs").delete_playback_key_pair method.