mypy-boto3-medialive
Type annotations for boto3 MediaLive 1.35.77
compatible with VSCode,
PyCharm,
Emacs,
Sublime Text,
mypy,
pyright and other tools.
Generated with
mypy-boto3-builder 8.6.2.
More information can be found on
boto3-stubs page and in
mypy-boto3-medialive docs.
See how it helps you find and fix potential bugs:
How to install
Generate locally (recommended)
You can generate type annotations for boto3
package locally with
mypy_boto3_builder
. Use
uv for build
isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.77' mypy_boto3_builder
- Select
boto3 (legacy boto3-stubs)
AWS SDK. - Add
MediaLive
service. - Use provided commands to install generated packages.
VSCode extension
Add
AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and MediaLive
.
From PyPI with pip
Install boto3-stubs
for MediaLive
service.
python -m pip install 'boto3-stubs[medialive]'
python -m pip install 'boto3-stubs-lite[medialive]'
python -m pip install mypy-boto3-medialive
How to uninstall
python -m pip uninstall -y mypy-boto3-medialive
Usage
VSCode
python -m pip install 'boto3-stubs[medialive]'
Both type checking and code completion should now work. No explicit type
annotations required, write your boto3
code as usual.
PyCharm
⚠️ Due to slow PyCharm performance on Literal
overloads (issue
PY-40997), it is recommended
to use boto3-stubs-lite until
the issue is resolved.
⚠️ If you experience slow performance and high CPU usage, try to disable
PyCharm
type checker and use mypy or
pyright instead.
⚠️ To continue using PyCharm
type checker, you can try to replace
boto3-stubs
with
boto3-stubs-lite:
pip uninstall boto3-stubs
pip install boto3-stubs-lite
Install boto3-stubs[medialive]
in your environment:
python -m pip install 'boto3-stubs[medialive]'
Both type checking and code completion should now work.
Emacs
- Install
boto3-stubs
with services you use in your environment:
python -m pip install 'boto3-stubs[medialive]'
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
- Make sure emacs uses the environment where you have installed
boto3-stubs
Type checking should now work. No explicit type annotations required, write
your boto3
code as usual.
Sublime Text
- Install
boto3-stubs[medialive]
with services you use in your environment:
python -m pip install 'boto3-stubs[medialive]'
Type checking should now work. No explicit type annotations required, write
your boto3
code as usual.
Other IDEs
Not tested, but as long as your IDE supports mypy
or pyright
, everything
should work.
mypy
- Install
mypy
: python -m pip install mypy
- Install
boto3-stubs[medialive]
in your environment:
python -m pip install 'boto3-stubs[medialive]'
Type checking should now work. No explicit type annotations required, write
your boto3
code as usual.
pyright
- Install
pyright
: npm i -g pyright
- Install
boto3-stubs[medialive]
in your environment:
python -m pip install 'boto3-stubs[medialive]'
Optionally, you can install boto3-stubs
to typings
directory.
Type checking should now work. No explicit type annotations required, write
your boto3
code as usual.
Pylint compatibility
It is totally safe to use TYPE_CHECKING
flag in order to avoid
mypy-boto3-medialive
dependency in production. However, there is an issue in
pylint
that it complains about undefined variables. To fix it, set all types
to object
in non-TYPE_CHECKING
mode.
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
else:
EC2Client = object
EC2ServiceResource = object
BundleTaskCompleteWaiter = object
DescribeVolumesPaginator = object
...
Explicit type annotations
Client annotations
MediaLiveClient
provides annotations for boto3.client("medialive")
.
from boto3.session import Session
from mypy_boto3_medialive import MediaLiveClient
client: MediaLiveClient = Session().client("medialive")
Paginators annotations
mypy_boto3_medialive.paginator
module contains type annotations for all
paginators.
from boto3.session import Session
from mypy_boto3_medialive import MediaLiveClient
from mypy_boto3_medialive.paginator import (
DescribeSchedulePaginator,
ListChannelPlacementGroupsPaginator,
ListChannelsPaginator,
ListCloudWatchAlarmTemplateGroupsPaginator,
ListCloudWatchAlarmTemplatesPaginator,
ListClustersPaginator,
ListEventBridgeRuleTemplateGroupsPaginator,
ListEventBridgeRuleTemplatesPaginator,
ListInputDeviceTransfersPaginator,
ListInputDevicesPaginator,
ListInputSecurityGroupsPaginator,
ListInputsPaginator,
ListMultiplexProgramsPaginator,
ListMultiplexesPaginator,
ListNetworksPaginator,
ListNodesPaginator,
ListOfferingsPaginator,
ListReservationsPaginator,
ListSignalMapsPaginator,
)
client: MediaLiveClient = Session().client("medialive")
describe_schedule_paginator: DescribeSchedulePaginator = client.get_paginator("describe_schedule")
list_channel_placement_groups_paginator: ListChannelPlacementGroupsPaginator = client.get_paginator(
"list_channel_placement_groups"
)
list_channels_paginator: ListChannelsPaginator = client.get_paginator("list_channels")
list_cloud_watch_alarm_template_groups_paginator: ListCloudWatchAlarmTemplateGroupsPaginator = (
client.get_paginator("list_cloud_watch_alarm_template_groups")
)
list_cloud_watch_alarm_templates_paginator: ListCloudWatchAlarmTemplatesPaginator = (
client.get_paginator("list_cloud_watch_alarm_templates")
)
list_clusters_paginator: ListClustersPaginator = client.get_paginator("list_clusters")
list_event_bridge_rule_template_groups_paginator: ListEventBridgeRuleTemplateGroupsPaginator = (
client.get_paginator("list_event_bridge_rule_template_groups")
)
list_event_bridge_rule_templates_paginator: ListEventBridgeRuleTemplatesPaginator = (
client.get_paginator("list_event_bridge_rule_templates")
)
list_input_device_transfers_paginator: ListInputDeviceTransfersPaginator = client.get_paginator(
"list_input_device_transfers"
)
list_input_devices_paginator: ListInputDevicesPaginator = client.get_paginator("list_input_devices")
list_input_security_groups_paginator: ListInputSecurityGroupsPaginator = client.get_paginator(
"list_input_security_groups"
)
list_inputs_paginator: ListInputsPaginator = client.get_paginator("list_inputs")
list_multiplex_programs_paginator: ListMultiplexProgramsPaginator = client.get_paginator(
"list_multiplex_programs"
)
list_multiplexes_paginator: ListMultiplexesPaginator = client.get_paginator("list_multiplexes")
list_networks_paginator: ListNetworksPaginator = client.get_paginator("list_networks")
list_nodes_paginator: ListNodesPaginator = client.get_paginator("list_nodes")
list_offerings_paginator: ListOfferingsPaginator = client.get_paginator("list_offerings")
list_reservations_paginator: ListReservationsPaginator = client.get_paginator("list_reservations")
list_signal_maps_paginator: ListSignalMapsPaginator = client.get_paginator("list_signal_maps")
Waiters annotations
mypy_boto3_medialive.waiter
module contains type annotations for all waiters.
from boto3.session import Session
from mypy_boto3_medialive import MediaLiveClient
from mypy_boto3_medialive.waiter import (
ChannelCreatedWaiter,
ChannelDeletedWaiter,
ChannelPlacementGroupAssignedWaiter,
ChannelPlacementGroupDeletedWaiter,
ChannelPlacementGroupUnassignedWaiter,
ChannelRunningWaiter,
ChannelStoppedWaiter,
ClusterCreatedWaiter,
ClusterDeletedWaiter,
InputAttachedWaiter,
InputDeletedWaiter,
InputDetachedWaiter,
MultiplexCreatedWaiter,
MultiplexDeletedWaiter,
MultiplexRunningWaiter,
MultiplexStoppedWaiter,
NodeDeregisteredWaiter,
NodeRegisteredWaiter,
SignalMapCreatedWaiter,
SignalMapMonitorDeletedWaiter,
SignalMapMonitorDeployedWaiter,
SignalMapUpdatedWaiter,
)
client: MediaLiveClient = Session().client("medialive")
channel_created_waiter: ChannelCreatedWaiter = client.get_waiter("channel_created")
channel_deleted_waiter: ChannelDeletedWaiter = client.get_waiter("channel_deleted")
channel_placement_group_assigned_waiter: ChannelPlacementGroupAssignedWaiter = client.get_waiter(
"channel_placement_group_assigned"
)
channel_placement_group_deleted_waiter: ChannelPlacementGroupDeletedWaiter = client.get_waiter(
"channel_placement_group_deleted"
)
channel_placement_group_unassigned_waiter: ChannelPlacementGroupUnassignedWaiter = (
client.get_waiter("channel_placement_group_unassigned")
)
channel_running_waiter: ChannelRunningWaiter = client.get_waiter("channel_running")
channel_stopped_waiter: ChannelStoppedWaiter = client.get_waiter("channel_stopped")
cluster_created_waiter: ClusterCreatedWaiter = client.get_waiter("cluster_created")
cluster_deleted_waiter: ClusterDeletedWaiter = client.get_waiter("cluster_deleted")
input_attached_waiter: InputAttachedWaiter = client.get_waiter("input_attached")
input_deleted_waiter: InputDeletedWaiter = client.get_waiter("input_deleted")
input_detached_waiter: InputDetachedWaiter = client.get_waiter("input_detached")
multiplex_created_waiter: MultiplexCreatedWaiter = client.get_waiter("multiplex_created")
multiplex_deleted_waiter: MultiplexDeletedWaiter = client.get_waiter("multiplex_deleted")
multiplex_running_waiter: MultiplexRunningWaiter = client.get_waiter("multiplex_running")
multiplex_stopped_waiter: MultiplexStoppedWaiter = client.get_waiter("multiplex_stopped")
node_deregistered_waiter: NodeDeregisteredWaiter = client.get_waiter("node_deregistered")
node_registered_waiter: NodeRegisteredWaiter = client.get_waiter("node_registered")
signal_map_created_waiter: SignalMapCreatedWaiter = client.get_waiter("signal_map_created")
signal_map_monitor_deleted_waiter: SignalMapMonitorDeletedWaiter = client.get_waiter(
"signal_map_monitor_deleted"
)
signal_map_monitor_deployed_waiter: SignalMapMonitorDeployedWaiter = client.get_waiter(
"signal_map_monitor_deployed"
)
signal_map_updated_waiter: SignalMapUpdatedWaiter = client.get_waiter("signal_map_updated")
Literals
mypy_boto3_medialive.literals
module contains literals extracted from shapes
that can be used in user code for type checking.
Full list of MediaLive
Literals can be found in
docs.
from mypy_boto3_medialive.literals import AacCodingModeType
def check_value(value: AacCodingModeType) -> bool: ...
Type definitions
mypy_boto3_medialive.type_defs
module contains structures and shapes
assembled to typed dictionaries and unions for additional type checking.
Full list of MediaLive
TypeDefs can be found in
docs.
from mypy_boto3_medialive.type_defs import AacSettingsTypeDef
def get_value() -> AacSettingsTypeDef:
return {...}
How it works
Fully automated
mypy-boto3-builder carefully
generates type annotations for each service, patiently waiting for boto3
updates. It delivers drop-in type annotations for you and makes sure that:
- All available
boto3
services are covered. - Each public class and method of every
boto3
service gets valid type
annotations extracted from botocore
schemas. - Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by ruff for readability.
What's new
Implemented features
- Fully type annotated
boto3
, botocore
, aiobotocore
and aioboto3
libraries mypy
, pyright
, VSCode
, PyCharm
, Sublime Text
and Emacs
compatibilityClient
, ServiceResource
, Resource
, Waiter
Paginator
type
annotations for each service- Generated
TypeDefs
for each service - Generated
Literals
for each service - Auto discovery of types for
boto3.client
and boto3.resource
calls - Auto discovery of types for
session.client
and session.resource
calls - Auto discovery of types for
client.get_waiter
and client.get_paginator
calls - Auto discovery of types for
ServiceResource
and Resource
collections - Auto discovery of types for
aiobotocore.Session.create_client
calls
Latest changes
Builder changelog can be found in
Releases.
Versioning
mypy-boto3-medialive
version is the same as related boto3
version and
follows PEP 440 format.
Thank you
Documentation
All services type annotations can be found in
boto3 docs
Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in mypy-boto3-builder
repository.