Type annotations for boto3.AppStream 1.14.0 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-appstream
Type annotations for boto3.AppStream 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for AppStream
service.
python -m pip install boto3-stubs[appstream]
How to use
Client annotations
AppStreamClient
provides annotations for boto3.client("appstream")
.
import boto3
from mypy_boto3_appstream import AppStreamClient
from mypy_boto3_appstream.paginator import (
DescribeDirectoryConfigsPaginator,
DescribeFleetsPaginator,
DescribeImageBuildersPaginator,
DescribeImagesPaginator,
DescribeSessionsPaginator,
DescribeStacksPaginator,
DescribeUsersPaginator,
DescribeUserStackAssociationsPaginator,
ListAssociatedFleetsPaginator,
ListAssociatedStacksPaginator,
)
from mypy_boto3_appstream.type_defs import AccessEndpointTypeDef, ...
from mypy_boto3_appstream.waiter import FleetStartedWaiter, FleetStoppedWaiter
client: AppStreamClient = boto3.client("appstream")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: AppStreamClient = session.client("appstream")
Paginators annotations
mypy_boto3_appstream.paginator
module contains type annotations for all paginators.
client: AppStreamClient = boto3.client("appstream")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_directory_configs_paginator: DescribeDirectoryConfigsPaginator = client.get_paginator("describe_directory_configs")
describe_fleets_paginator: DescribeFleetsPaginator = client.get_paginator("describe_fleets")
describe_image_builders_paginator: DescribeImageBuildersPaginator = client.get_paginator("describe_image_builders")
describe_images_paginator: DescribeImagesPaginator = client.get_paginator("describe_images")
describe_sessions_paginator: DescribeSessionsPaginator = client.get_paginator("describe_sessions")
describe_stacks_paginator: DescribeStacksPaginator = client.get_paginator("describe_stacks")
describe_user_stack_associations_paginator: DescribeUserStackAssociationsPaginator = client.get_paginator("describe_user_stack_associations")
describe_users_paginator: DescribeUsersPaginator = client.get_paginator("describe_users")
list_associated_fleets_paginator: ListAssociatedFleetsPaginator = client.get_paginator("list_associated_fleets")
list_associated_stacks_paginator: ListAssociatedStacksPaginator = client.get_paginator("list_associated_stacks")
Waiters annotations
mypy_boto3_appstream.waiter
module contains type annotations for all waiters.
client: AppStreamClient = boto3.client("appstream")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
fleet_started_waiter: FleetStartedWaiter = client.get_waiter("fleet_started")
fleet_stopped_waiter: FleetStoppedWaiter = client.get_waiter("fleet_stopped")
Typed dictionations
mypy_boto3_appstream.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AccessEndpointTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_appstream
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("appstream")
session_client = boto3.Session().client("appstream")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-appstream-1.14.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 59b41ede3ce095c4aaf57889eac7ccd1e9887d3fe173c74c11ae32f41c063b79 |
|
MD5 | 27b3b00e3ca79f6073f3d96b05e32bb3 |
|
BLAKE2b-256 | 3bef8982ce970eadfd91d85de2a276f86d5c1822b9b35c3e5549a0d29cb6b606 |
Hashes for mypy_boto3_appstream-1.14.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7d62b2a7942755e39ba1775d0260db4933c48337334b104f54580041f80c6b3 |
|
MD5 | aa47911ae2d89299a680d202b60e402c |
|
BLAKE2b-256 | fdf7b69e5bdd4e5e9ad59bb03d5a1f9a15d7ca6ef74d0926a5c8053caba98684 |