IVSClient
Auto-generated documentation for IVS type annotations stubs module types-aiobotocore-ivs.
IVSClient
Type annotations and code completion for session.client("ivs")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_ivs.client import IVSClient
session = Session()
async with session.client("ivs") as client:
client: IVSClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("ivs").exceptions
structure.
async with session.client("ivs") as client:
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)
from types_aiobotocore_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 session.client("ivs").batch_get_channel
method.
boto3 documentation
await def batch_get_channel(
self,
*,
arns: Sequence[str],
) -> BatchGetChannelResponseTypeDef: # (1)
...
kwargs: BatchGetChannelRequestRequestTypeDef = { # (1)
"arns": ...,
}
parent.batch_get_channel(**kwargs)
batch_get_stream_key
Performs GetStreamKey on multiple ARNs simultaneously.
Type annotations and code completion for session.client("ivs").batch_get_stream_key
method.
boto3 documentation
await def batch_get_stream_key(
self,
*,
arns: Sequence[str],
) -> BatchGetStreamKeyResponseTypeDef: # (1)
...
kwargs: BatchGetStreamKeyRequestRequestTypeDef = { # (1)
"arns": ...,
}
parent.batch_get_stream_key(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for session.client("ivs").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("ivs").close
method.
boto3 documentation
create_channel
Creates a new channel and an associated stream key to start streaming.
Type annotations and code completion for session.client("ivs").create_channel
method.
boto3 documentation
await def create_channel(
self,
*,
authorized: bool = ...,
latencyMode: ChannelLatencyModeType = ..., # (1)
name: str = ...,
recordingConfigurationArn: str = ...,
tags: Mapping[str, str] = ...,
type: ChannelTypeType = ..., # (2)
) -> CreateChannelResponseTypeDef: # (3)
...
kwargs: CreateChannelRequestRequestTypeDef = { # (1)
"authorized": ...,
}
parent.create_channel(**kwargs)
create_recording_configuration
Creates a new recording configuration, used to enable recording to Amazon S3.
Type annotations and code completion for session.client("ivs").create_recording_configuration
method.
boto3 documentation
await def create_recording_configuration(
self,
*,
destinationConfiguration: DestinationConfigurationTypeDef, # (1)
name: str = ...,
tags: Mapping[str, str] = ...,
thumbnailConfiguration: ThumbnailConfigurationTypeDef = ..., # (2)
) -> CreateRecordingConfigurationResponseTypeDef: # (3)
...
- See DestinationConfigurationTypeDef
- See ThumbnailConfigurationTypeDef
- See CreateRecordingConfigurationResponseTypeDef
kwargs: CreateRecordingConfigurationRequestRequestTypeDef = { # (1)
"destinationConfiguration": ...,
}
parent.create_recording_configuration(**kwargs)
create_stream_key
Creates a stream key, used to initiate a stream, for the specified channel ARN.
Type annotations and code completion for session.client("ivs").create_stream_key
method.
boto3 documentation
await def create_stream_key(
self,
*,
channelArn: str,
tags: Mapping[str, str] = ...,
) -> CreateStreamKeyResponseTypeDef: # (1)
...
kwargs: CreateStreamKeyRequestRequestTypeDef = { # (1)
"channelArn": ...,
}
parent.create_stream_key(**kwargs)
delete_channel
Deletes the specified channel and its associated stream keys.
Type annotations and code completion for session.client("ivs").delete_channel
method.
boto3 documentation
await def delete_channel(
self,
*,
arn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteChannelRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_channel(**kwargs)
delete_playback_key_pair
Deletes a specified authorization key pair.
Type annotations and code completion for session.client("ivs").delete_playback_key_pair
method.
boto3 documentation
kwargs: DeletePlaybackKeyPairRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_playback_key_pair(**kwargs)
delete_recording_configuration
Deletes the recording configuration for the specified ARN.
Type annotations and code completion for session.client("ivs").delete_recording_configuration
method.
boto3 documentation
await def delete_recording_configuration(
self,
*,
arn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteRecordingConfigurationRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_recording_configuration(**kwargs)
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 session.client("ivs").delete_stream_key
method.
boto3 documentation
await def delete_stream_key(
self,
*,
arn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteStreamKeyRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_stream_key(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("ivs").generate_presigned_url
method.
boto3 documentation
await 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 session.client("ivs").get_channel
method.
boto3 documentation
await def get_channel(
self,
*,
arn: str,
) -> GetChannelResponseTypeDef: # (1)
...
kwargs: GetChannelRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_channel(**kwargs)
get_playback_key_pair
Gets a specified playback authorization key pair and returns the arn
and
fingerprint
.
Type annotations and code completion for session.client("ivs").get_playback_key_pair
method.
boto3 documentation
await def get_playback_key_pair(
self,
*,
arn: str,
) -> GetPlaybackKeyPairResponseTypeDef: # (1)
...
kwargs: GetPlaybackKeyPairRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_playback_key_pair(**kwargs)
get_recording_configuration
Gets the recording configuration for the specified ARN.
Type annotations and code completion for session.client("ivs").get_recording_configuration
method.
boto3 documentation
await def get_recording_configuration(
self,
*,
arn: str,
) -> GetRecordingConfigurationResponseTypeDef: # (1)
...
kwargs: GetRecordingConfigurationRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_recording_configuration(**kwargs)
get_stream
Gets information about the active (live) stream on a specified channel.
Type annotations and code completion for session.client("ivs").get_stream
method.
boto3 documentation
await def get_stream(
self,
*,
channelArn: str,
) -> GetStreamResponseTypeDef: # (1)
...
kwargs: GetStreamRequestRequestTypeDef = { # (1)
"channelArn": ...,
}
parent.get_stream(**kwargs)
get_stream_key
Gets stream-key information for a specified ARN.
Type annotations and code completion for session.client("ivs").get_stream_key
method.
boto3 documentation
await def get_stream_key(
self,
*,
arn: str,
) -> GetStreamKeyResponseTypeDef: # (1)
...
kwargs: GetStreamKeyRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_stream_key(**kwargs)
get_stream_session
Gets metadata on a specified stream.
Type annotations and code completion for session.client("ivs").get_stream_session
method.
boto3 documentation
await def get_stream_session(
self,
*,
channelArn: str,
streamId: str = ...,
) -> GetStreamSessionResponseTypeDef: # (1)
...
kwargs: GetStreamSessionRequestRequestTypeDef = { # (1)
"channelArn": ...,
}
parent.get_stream_session(**kwargs)
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 session.client("ivs").import_playback_key_pair
method.
boto3 documentation
await def import_playback_key_pair(
self,
*,
publicKeyMaterial: str,
name: str = ...,
tags: Mapping[str, str] = ...,
) -> ImportPlaybackKeyPairResponseTypeDef: # (1)
...
kwargs: ImportPlaybackKeyPairRequestRequestTypeDef = { # (1)
"publicKeyMaterial": ...,
}
parent.import_playback_key_pair(**kwargs)
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 session.client("ivs").list_channels
method.
boto3 documentation
await def list_channels(
self,
*,
filterByName: str = ...,
filterByRecordingConfigurationArn: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListChannelsResponseTypeDef: # (1)
...
kwargs: ListChannelsRequestRequestTypeDef = { # (1)
"filterByName": ...,
}
parent.list_channels(**kwargs)
list_playback_key_pairs
Gets summary information about playback key pairs.
Type annotations and code completion for session.client("ivs").list_playback_key_pairs
method.
boto3 documentation
await def list_playback_key_pairs(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListPlaybackKeyPairsResponseTypeDef: # (1)
...
kwargs: ListPlaybackKeyPairsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_playback_key_pairs(**kwargs)
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 session.client("ivs").list_recording_configurations
method.
boto3 documentation
await def list_recording_configurations(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListRecordingConfigurationsResponseTypeDef: # (1)
...
kwargs: ListRecordingConfigurationsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_recording_configurations(**kwargs)
list_stream_keys
Gets summary information about stream keys for the specified channel.
Type annotations and code completion for session.client("ivs").list_stream_keys
method.
boto3 documentation
await def list_stream_keys(
self,
*,
channelArn: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListStreamKeysResponseTypeDef: # (1)
...
kwargs: ListStreamKeysRequestRequestTypeDef = { # (1)
"channelArn": ...,
}
parent.list_stream_keys(**kwargs)
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 session.client("ivs").list_stream_sessions
method.
boto3 documentation
await def list_stream_sessions(
self,
*,
channelArn: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListStreamSessionsResponseTypeDef: # (1)
...
kwargs: ListStreamSessionsRequestRequestTypeDef = { # (1)
"channelArn": ...,
}
parent.list_stream_sessions(**kwargs)
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 session.client("ivs").list_streams
method.
boto3 documentation
await def list_streams(
self,
*,
filterBy: StreamFiltersTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListStreamsResponseTypeDef: # (2)
...
kwargs: ListStreamsRequestRequestTypeDef = { # (1)
"filterBy": ...,
}
parent.list_streams(**kwargs)
list_tags_for_resource
Gets information about Amazon Web Services tags for the specified ARN.
Type annotations and code completion for session.client("ivs").list_tags_for_resource
method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
put_metadata
Inserts metadata into the active stream of the specified channel.
Type annotations and code completion for session.client("ivs").put_metadata
method.
boto3 documentation
await def put_metadata(
self,
*,
channelArn: str,
metadata: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: PutMetadataRequestRequestTypeDef = { # (1)
"channelArn": ...,
"metadata": ...,
}
parent.put_metadata(**kwargs)
stop_stream
Disconnects the incoming RTMPS stream for the specified channel.
Type annotations and code completion for session.client("ivs").stop_stream
method.
boto3 documentation
kwargs: StopStreamRequestRequestTypeDef = { # (1)
"channelArn": ...,
}
parent.stop_stream(**kwargs)
tag_resource
Adds or updates tags for the Amazon Web Services resource with the specified ARN.
Type annotations and code completion for session.client("ivs").tag_resource
method.
boto3 documentation
await def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
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 session.client("ivs").untag_resource
method.
boto3 documentation
await def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_channel
Updates a channel's configuration.
Type annotations and code completion for session.client("ivs").update_channel
method.
boto3 documentation
await def update_channel(
self,
*,
arn: str,
authorized: bool = ...,
latencyMode: ChannelLatencyModeType = ..., # (1)
name: str = ...,
recordingConfigurationArn: str = ...,
type: ChannelTypeType = ..., # (2)
) -> UpdateChannelResponseTypeDef: # (3)
...
kwargs: UpdateChannelRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.update_channel(**kwargs)
__aenter__
Type annotations and code completion for session.client("ivs").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("ivs").__aexit__
method.
boto3 documentation
get_paginator
Type annotations and code completion for session.client("ivs").get_paginator
method with overloads.
client.get_paginator("list_channels")
-> ListChannelsPaginatorclient.get_paginator("list_playback_key_pairs")
-> ListPlaybackKeyPairsPaginatorclient.get_paginator("list_recording_configurations")
-> ListRecordingConfigurationsPaginatorclient.get_paginator("list_stream_keys")
-> ListStreamKeysPaginatorclient.get_paginator("list_streams")
-> ListStreamsPaginator