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

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.

Usage example

client = boto3.client("ivs")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ChannelNotBroadcasting,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.PendingVerification,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.StreamUnavailable,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)

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

Method definition

def batch_get_channel(
    self,
    *,
    arns: Sequence[str],
) -> BatchGetChannelResponseTypeDef:  # (1)
    ...

1. See BatchGetChannelResponseTypeDef

Usage example with kwargs

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

Method definition

def batch_get_stream_key(
    self,
    *,
    arns: Sequence[str],
) -> BatchGetStreamKeyResponseTypeDef:  # (1)
    ...

1. See BatchGetStreamKeyResponseTypeDef

Usage example with kwargs

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

parent.batch_get_stream_key(**kwargs)

1. See BatchGetStreamKeyRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

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

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

Method definition

def create_channel(
    self,
    *,
    authorized: bool = ...,
    latencyMode: ChannelLatencyModeType = ...,  # (1)
    name: str = ...,
    recordingConfigurationArn: str = ...,
    tags: Mapping[str, str] = ...,
    type: ChannelTypeType = ...,  # (2)
) -> CreateChannelResponseTypeDef:  # (3)
    ...

1. See ChannelLatencyModeType
2. See ChannelTypeType
3. See CreateChannelResponseTypeDef

Usage example with kwargs

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

parent.create_channel(**kwargs)

1. See CreateChannelRequestRequestTypeDef

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

Method definition

def create_recording_configuration(
    self,
    *,
    destinationConfiguration: DestinationConfigurationTypeDef,  # (1)
    name: str = ...,
    recordingReconnectWindowSeconds: int = ...,
    tags: Mapping[str, str] = ...,
    thumbnailConfiguration: ThumbnailConfigurationTypeDef = ...,  # (2)
) -> CreateRecordingConfigurationResponseTypeDef:  # (3)
    ...

1. See DestinationConfigurationTypeDef
2. See ThumbnailConfigurationTypeDef
3. See CreateRecordingConfigurationResponseTypeDef

Usage example with kwargs

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

Method definition

def create_stream_key(
    self,
    *,
    channelArn: str,
    tags: Mapping[str, str] = ...,
) -> CreateStreamKeyResponseTypeDef:  # (1)
    ...

1. See CreateStreamKeyResponseTypeDef

Usage example with kwargs

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

Method definition

def delete_channel(
    self,
    *,
    arn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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. boto3 documentation

Method definition

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

Usage example with kwargs

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

parent.delete_playback_key_pair(**kwargs)

1. See DeletePlaybackKeyPairRequestRequestTypeDef

delete_recording_configuration

Deletes the recording configuration for the specified ARN.

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

Method definition

def delete_recording_configuration(
    self,
    *,
    arn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_recording_configuration(**kwargs)

1. See DeleteRecordingConfigurationRequestRequestTypeDef

delete_stream_key

Deletes the stream key for the specified ARN, so it can no longer be used to stream.

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

Method definition

def delete_stream_key(
    self,
    *,
    arn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_stream_key(**kwargs)

1. See DeleteStreamKeyRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_channel

Gets the channel configuration for the specified channel ARN.

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

Method definition

def get_channel(
    self,
    *,
    arn: str,
) -> GetChannelResponseTypeDef:  # (1)
    ...

1. See GetChannelResponseTypeDef

Usage example with kwargs

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

parent.get_channel(**kwargs)

1. See GetChannelRequestRequestTypeDef

get_playback_key_pair

Gets a specified playback authorization key pair and returns the arn and fingerprint.

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

Method definition

def get_playback_key_pair(
    self,
    *,
    arn: str,
) -> GetPlaybackKeyPairResponseTypeDef:  # (1)
    ...

1. See GetPlaybackKeyPairResponseTypeDef

Usage example with kwargs

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

parent.get_playback_key_pair(**kwargs)

1. See GetPlaybackKeyPairRequestRequestTypeDef

get_recording_configuration

Gets the recording configuration for the specified ARN.

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

Method definition

def get_recording_configuration(
    self,
    *,
    arn: str,
) -> GetRecordingConfigurationResponseTypeDef:  # (1)
    ...

1. See GetRecordingConfigurationResponseTypeDef

Usage example with kwargs

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

parent.get_recording_configuration(**kwargs)

1. See GetRecordingConfigurationRequestRequestTypeDef

get_stream

Gets information about the active (live) stream on a specified channel.

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

Method definition

def get_stream(
    self,
    *,
    channelArn: str,
) -> GetStreamResponseTypeDef:  # (1)
    ...

1. See GetStreamResponseTypeDef

Usage example with kwargs

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

parent.get_stream(**kwargs)

1. See GetStreamRequestRequestTypeDef

get_stream_key

Gets stream-key information for a specified ARN.

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

Method definition

def get_stream_key(
    self,
    *,
    arn: str,
) -> GetStreamKeyResponseTypeDef:  # (1)
    ...

1. See GetStreamKeyResponseTypeDef

Usage example with kwargs

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

parent.get_stream_key(**kwargs)

1. See GetStreamKeyRequestRequestTypeDef

get_stream_session

Gets metadata on a specified stream.

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

Method definition

def get_stream_session(
    self,
    *,
    channelArn: str,
    streamId: str = ...,
) -> GetStreamSessionResponseTypeDef:  # (1)
    ...

1. See GetStreamSessionResponseTypeDef

Usage example with kwargs

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

parent.get_stream_session(**kwargs)

1. See GetStreamSessionRequestRequestTypeDef

import_playback_key_pair

Imports the public portion of a new key pair and returns its arn and fingerprint.

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

Method definition

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

1. See ImportPlaybackKeyPairResponseTypeDef

Usage example with kwargs

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

parent.import_playback_key_pair(**kwargs)

1. See ImportPlaybackKeyPairRequestRequestTypeDef

list_channels

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed.

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

Method definition

def list_channels(
    self,
    *,
    filterByName: str = ...,
    filterByRecordingConfigurationArn: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListChannelsResponseTypeDef:  # (1)
    ...

1. See ListChannelsResponseTypeDef

Usage example with kwargs

kwargs: ListChannelsRequestRequestTypeDef = {  # (1)
    "filterByName": ...,
}

parent.list_channels(**kwargs)

1. See ListChannelsRequestRequestTypeDef

list_playback_key_pairs

Gets summary information about playback key pairs.

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

Method definition

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

1. See ListPlaybackKeyPairsResponseTypeDef

Usage example with kwargs

kwargs: ListPlaybackKeyPairsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_playback_key_pairs(**kwargs)

1. See ListPlaybackKeyPairsRequestRequestTypeDef

list_recording_configurations

Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

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

Method definition

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

1. See ListRecordingConfigurationsResponseTypeDef

Usage example with kwargs

kwargs: ListRecordingConfigurationsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_recording_configurations(**kwargs)

1. See ListRecordingConfigurationsRequestRequestTypeDef

list_stream_keys

Gets summary information about stream keys for the specified channel.

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

Method definition

def list_stream_keys(
    self,
    *,
    channelArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListStreamKeysResponseTypeDef:  # (1)
    ...

1. See ListStreamKeysResponseTypeDef

Usage example with kwargs

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

parent.list_stream_keys(**kwargs)

1. See ListStreamKeysRequestRequestTypeDef

list_stream_sessions

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

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

Method definition

def list_stream_sessions(
    self,
    *,
    channelArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListStreamSessionsResponseTypeDef:  # (1)
    ...

1. See ListStreamSessionsResponseTypeDef

Usage example with kwargs

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

parent.list_stream_sessions(**kwargs)

1. See ListStreamSessionsRequestRequestTypeDef

list_streams

Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

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

Method definition

def list_streams(
    self,
    *,
    filterBy: StreamFiltersTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListStreamsResponseTypeDef:  # (2)
    ...

1. See StreamFiltersTypeDef
2. See ListStreamsResponseTypeDef

Usage example with kwargs

kwargs: ListStreamsRequestRequestTypeDef = {  # (1)
    "filterBy": ...,
}

parent.list_streams(**kwargs)

1. See ListStreamsRequestRequestTypeDef

list_tags_for_resource

Gets information about Amazon Web Services tags for the specified ARN.

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

Method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

put_metadata

Inserts metadata into the active stream of the specified channel.

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

Method definition

def put_metadata(
    self,
    *,
    channelArn: str,
    metadata: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.put_metadata(**kwargs)

1. See PutMetadataRequestRequestTypeDef

stop_stream

Disconnects the incoming RTMPS stream for the specified channel.

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

Method definition

def stop_stream(
    self,
    *,
    channelArn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.stop_stream(**kwargs)

1. See StopStreamRequestRequestTypeDef

tag_resource

Adds or updates tags for the Amazon Web Services resource with the specified ARN.

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

Method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes tags from the resource with the specified ARN.

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

Method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_channel

Updates a channel's configuration.

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

Method definition

def update_channel(
    self,
    *,
    arn: str,
    authorized: bool = ...,
    latencyMode: ChannelLatencyModeType = ...,  # (1)
    name: str = ...,
    recordingConfigurationArn: str = ...,
    type: ChannelTypeType = ...,  # (2)
) -> UpdateChannelResponseTypeDef:  # (3)
    ...

1. See ChannelLatencyModeType
2. See ChannelTypeType
3. See UpdateChannelResponseTypeDef

Usage example with kwargs

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

parent.update_channel(**kwargs)

1. See UpdateChannelRequestRequestTypeDef

get_paginator

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

• client.get_paginator("list_channels") -> ListChannelsPaginator
• client.get_paginator("list_playback_key_pairs") -> ListPlaybackKeyPairsPaginator
• client.get_paginator("list_recording_configurations") -> ListRecordingConfigurationsPaginator
• client.get_paginator("list_stream_keys") -> ListStreamKeysPaginator
• client.get_paginator("list_streams") -> ListStreamsPaginator