%global _empty_manifest_terminate_build 0 Name: python-mypy-boto3-appstream Version: 1.26.59 Release: 1 Summary: Type annotations for boto3.AppStream 1.26.59 service generated with mypy-boto3-builder 7.12.3 License: MIT License URL: https://github.com/youtype/mypy_boto3_builder Source0: https://mirrors.nju.edu.cn/pypi/web/packages/65/5e/a9b94d23390caac36d878599328943128dc947c703d436dd80776dc67f14/mypy-boto3-appstream-1.26.59.tar.gz BuildArch: noarch Requires: python3-typing-extensions %description # mypy-boto3-appstream [![PyPI - mypy-boto3-appstream](https://img.shields.io/pypi/v/mypy-boto3-appstream.svg?color=blue)](https://pypi.org/project/mypy-boto3-appstream) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-appstream.svg?color=blue)](https://pypi.org/project/mypy-boto3-appstream) [![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-appstream?color=blue)](https://pypistats.org/packages/mypy-boto3-appstream) ![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png) Type annotations for [boto3.AppStream 1.26.59](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/appstream.html#AppStream) service compatible with [VSCode](https://code.visualstudio.com/), [PyCharm](https://www.jetbrains.com/pycharm/), [Emacs](https://www.gnu.org/software/emacs/), [Sublime Text](https://www.sublimetext.com/), [mypy](https://github.com/python/mypy), [pyright](https://github.com/microsoft/pyright) and other tools. Generated by [mypy-boto3-builder 7.12.3](https://github.com/youtype/mypy_boto3_builder). More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in [mypy-boto3-appstream docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_appstream/). See how it helps to find and fix potential bugs: ![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif) - [mypy-boto3-appstream](#mypy-boto3-appstream) - [How to install](#how-to-install) - [VSCode extension](#vscode-extension) - [From PyPI with pip](#from-pypi-with-pip) - [How to uninstall](#how-to-uninstall) - [Usage](#usage) - [VSCode](#vscode) - [PyCharm](#pycharm) - [Emacs](#emacs) - [Sublime Text](#sublime-text) - [Other IDEs](#other-ides) - [mypy](#mypy) - [pyright](#pyright) - [Explicit type annotations](#explicit-type-annotations) - [Client annotations](#client-annotations) - [Paginators annotations](#paginators-annotations) - [Waiters annotations](#waiters-annotations) - [Literals](#literals) - [Typed dictionaries](#typed-dictionaries) - [How it works](#how-it-works) - [What's new](#what's-new) - [Implemented features](#implemented-features) - [Latest changes](#latest-changes) - [Versioning](#versioning) - [Thank you](#thank-you) - [Documentation](#documentation) - [Support and contributing](#support-and-contributing) ## How to install ### VSCode extension Add [AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) extension to your VSCode and run `AWS boto3: Quick Start` command. Click `Modify` and select `boto3 common` and `AppStream`. ### From PyPI with pip Install `boto3-stubs` for `AppStream` service. ```bash # install with boto3 type annotations python -m pip install 'boto3-stubs[appstream]' # Lite version does not provide session.client/resource overloads # it is more RAM-friendly, but requires explicit type annotations python -m pip install 'boto3-stubs-lite[appstream]' # standalone installation python -m pip install mypy-boto3-appstream ``` ## How to uninstall ```bash python -m pip uninstall -y mypy-boto3-appstream ``` ## Usage ### VSCode - Install [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - Install [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) - Set `Pylance` as your Python Language Server - Install `boto3-stubs[appstream]` in your environment: ```bash python -m pip install 'boto3-stubs[appstream]' ``` Both type checking and code completion should now work. No explicit type annotations required, write your `boto3` code as usual. ### PyCharm Install `boto3-stubs-lite[appstream]` in your environment: ```bash python -m pip install 'boto3-stubs-lite[appstream]'` ``` Both type checking and code completion should now work. Explicit type annotations **are required**. Use `boto3-stubs` package instead for implicit type discovery. ### Emacs - Install `boto3-stubs` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[appstream]' ``` - Install [use-package](https://github.com/jwiegley/use-package), [lsp](https://github.com/emacs-lsp/lsp-mode/), [company](https://github.com/company-mode/company-mode) and [flycheck](https://github.com/flycheck/flycheck) packages - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package ```elisp (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[appstream]` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[appstream]' ``` - Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package 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[appstream]` in your environment: ```bash python -m pip install 'boto3-stubs[appstream]'` ``` 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[appstream]` in your environment: ```bash python -m pip install 'boto3-stubs[appstream]' ``` Optionally, you can install `boto3-stubs` to `typings` folder. Type checking should now work. No explicit type annotations required, write your `boto3` code as usual. ## Explicit type annotations ### Client annotations `AppStreamClient` provides annotations for `boto3.client("appstream")`. ```python from boto3.session import Session from mypy_boto3_appstream import AppStreamClient client: AppStreamClient = Session().client("appstream") # now client usage is checked by mypy and IDE should provide code completion ``` ### Paginators annotations `mypy_boto3_appstream.paginator` module contains type annotations for all paginators. ```python from boto3.session import Session from mypy_boto3_appstream import AppStreamClient from mypy_boto3_appstream.paginator import ( DescribeDirectoryConfigsPaginator, DescribeFleetsPaginator, DescribeImageBuildersPaginator, DescribeImagesPaginator, DescribeSessionsPaginator, DescribeStacksPaginator, DescribeUserStackAssociationsPaginator, DescribeUsersPaginator, ListAssociatedFleetsPaginator, ListAssociatedStacksPaginator, ) client: AppStreamClient = Session().client("appstream") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs 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. ```python from boto3.session import Session from mypy_boto3_appstream import AppStreamClient from mypy_boto3_appstream.waiter import FleetStartedWaiter, FleetStoppedWaiter client: AppStreamClient = Session().client("appstream") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs fleet_started_waiter: FleetStartedWaiter = client.get_waiter("fleet_started") fleet_stopped_waiter: FleetStoppedWaiter = client.get_waiter("fleet_stopped") ``` ### Literals `mypy_boto3_appstream.literals` module contains literals extracted from shapes that can be used in user code for type checking. ```python from mypy_boto3_appstream.literals import ( AccessEndpointTypeType, ActionType, AppVisibilityType, ApplicationAttributeType, AuthenticationTypeType, CertificateBasedAuthStatusType, DescribeDirectoryConfigsPaginatorName, DescribeFleetsPaginatorName, DescribeImageBuildersPaginatorName, DescribeImagesPaginatorName, DescribeSessionsPaginatorName, DescribeStacksPaginatorName, DescribeUserStackAssociationsPaginatorName, DescribeUsersPaginatorName, FleetAttributeType, FleetErrorCodeType, FleetStartedWaiterName, FleetStateType, FleetStoppedWaiterName, FleetTypeType, ImageBuilderStateChangeReasonCodeType, ImageBuilderStateType, ImageStateChangeReasonCodeType, ImageStateType, ListAssociatedFleetsPaginatorName, ListAssociatedStacksPaginatorName, MessageActionType, PermissionType, PlatformTypeType, PreferredProtocolType, SessionConnectionStateType, SessionStateType, StackAttributeType, StackErrorCodeType, StorageConnectorTypeType, StreamViewType, UsageReportExecutionErrorCodeType, UsageReportScheduleType, UserStackAssociationErrorCodeType, VisibilityTypeType, AppStreamServiceName, ServiceName, ResourceServiceName, PaginatorName, WaiterName, RegionName, ) def check_value(value: AccessEndpointTypeType) -> bool: ... ``` ### Typed dictionaries `mypy_boto3_appstream.type_defs` module contains structures and shapes assembled to typed dictionaries for additional type checking. ```python from mypy_boto3_appstream.type_defs import ( AccessEndpointTypeDef, S3LocationTypeDef, ApplicationFleetAssociationTypeDef, ApplicationSettingsResponseTypeDef, ApplicationSettingsTypeDef, AssociateApplicationFleetRequestRequestTypeDef, ResponseMetadataTypeDef, AssociateApplicationToEntitlementRequestRequestTypeDef, AssociateFleetRequestRequestTypeDef, UserStackAssociationTypeDef, CertificateBasedAuthPropertiesTypeDef, ComputeCapacityStatusTypeDef, ComputeCapacityTypeDef, CopyImageRequestRequestTypeDef, ServiceAccountCredentialsTypeDef, EntitlementAttributeTypeDef, DomainJoinInfoTypeDef, VpcConfigTypeDef, CreateImageBuilderStreamingURLRequestRequestTypeDef, StorageConnectorTypeDef, StreamingExperienceSettingsTypeDef, UserSettingTypeDef, CreateStreamingURLRequestRequestTypeDef, CreateUpdatedImageRequestRequestTypeDef, CreateUserRequestRequestTypeDef, DeleteAppBlockRequestRequestTypeDef, DeleteApplicationRequestRequestTypeDef, DeleteDirectoryConfigRequestRequestTypeDef, DeleteEntitlementRequestRequestTypeDef, DeleteFleetRequestRequestTypeDef, DeleteImageBuilderRequestRequestTypeDef, DeleteImagePermissionsRequestRequestTypeDef, DeleteImageRequestRequestTypeDef, DeleteStackRequestRequestTypeDef, DeleteUserRequestRequestTypeDef, DescribeAppBlocksRequestRequestTypeDef, DescribeApplicationFleetAssociationsRequestRequestTypeDef, DescribeApplicationsRequestRequestTypeDef, PaginatorConfigTypeDef, DescribeDirectoryConfigsRequestRequestTypeDef, DescribeEntitlementsRequestRequestTypeDef, WaiterConfigTypeDef, DescribeFleetsRequestRequestTypeDef, DescribeImageBuildersRequestRequestTypeDef, DescribeImagePermissionsRequestRequestTypeDef, DescribeImagesRequestRequestTypeDef, DescribeSessionsRequestRequestTypeDef, DescribeStacksRequestRequestTypeDef, DescribeUsageReportSubscriptionsRequestRequestTypeDef, DescribeUserStackAssociationsRequestRequestTypeDef, DescribeUsersRequestRequestTypeDef, UserTypeDef, DisableUserRequestRequestTypeDef, DisassociateApplicationFleetRequestRequestTypeDef, DisassociateApplicationFromEntitlementRequestRequestTypeDef, DisassociateFleetRequestRequestTypeDef, EnableUserRequestRequestTypeDef, EntitledApplicationTypeDef, ExpireSessionRequestRequestTypeDef, FleetErrorTypeDef, ImageBuilderStateChangeReasonTypeDef, NetworkAccessConfigurationTypeDef, ResourceErrorTypeDef, ImagePermissionsTypeDef, ImageStateChangeReasonTypeDef, LastReportGenerationExecutionErrorTypeDef, ListAssociatedFleetsRequestRequestTypeDef, ListAssociatedStacksRequestRequestTypeDef, ListEntitledApplicationsRequestRequestTypeDef, ListTagsForResourceRequestRequestTypeDef, StackErrorTypeDef, StartFleetRequestRequestTypeDef, StartImageBuilderRequestRequestTypeDef, StopFleetRequestRequestTypeDef, StopImageBuilderRequestRequestTypeDef, TagResourceRequestRequestTypeDef, UntagResourceRequestRequestTypeDef, ApplicationTypeDef, CreateApplicationRequestRequestTypeDef, ScriptDetailsTypeDef, UpdateApplicationRequestRequestTypeDef, AssociateApplicationFleetResultTypeDef, CopyImageResponseTypeDef, CreateImageBuilderStreamingURLResultTypeDef, CreateStreamingURLResultTypeDef, CreateUsageReportSubscriptionResultTypeDef, DescribeApplicationFleetAssociationsResultTypeDef, ListAssociatedFleetsResultTypeDef, ListAssociatedStacksResultTypeDef, ListTagsForResourceResponseTypeDef, BatchAssociateUserStackRequestRequestTypeDef, BatchDisassociateUserStackRequestRequestTypeDef, DescribeUserStackAssociationsResultTypeDef, UserStackAssociationErrorTypeDef, CreateDirectoryConfigRequestRequestTypeDef, DirectoryConfigTypeDef, UpdateDirectoryConfigRequestRequestTypeDef, CreateEntitlementRequestRequestTypeDef, EntitlementTypeDef, UpdateEntitlementRequestRequestTypeDef, CreateFleetRequestRequestTypeDef, CreateImageBuilderRequestRequestTypeDef, UpdateFleetRequestRequestTypeDef, CreateStackRequestRequestTypeDef, UpdateStackRequestRequestTypeDef, DescribeDirectoryConfigsRequestDescribeDirectoryConfigsPaginateTypeDef, DescribeFleetsRequestDescribeFleetsPaginateTypeDef, DescribeImageBuildersRequestDescribeImageBuildersPaginateTypeDef, DescribeImagesRequestDescribeImagesPaginateTypeDef, DescribeSessionsRequestDescribeSessionsPaginateTypeDef, DescribeStacksRequestDescribeStacksPaginateTypeDef, DescribeUserStackAssociationsRequestDescribeUserStackAssociationsPaginateTypeDef, DescribeUsersRequestDescribeUsersPaginateTypeDef, ListAssociatedFleetsRequestListAssociatedFleetsPaginateTypeDef, ListAssociatedStacksRequestListAssociatedStacksPaginateTypeDef, DescribeFleetsRequestFleetStartedWaitTypeDef, DescribeFleetsRequestFleetStoppedWaitTypeDef, DescribeUsersResultTypeDef, ListEntitledApplicationsResultTypeDef, FleetTypeDef, SessionTypeDef, ImageBuilderTypeDef, SharedImagePermissionsTypeDef, UpdateImagePermissionsRequestRequestTypeDef, UsageReportSubscriptionTypeDef, StackTypeDef, CreateApplicationResultTypeDef, DescribeApplicationsResultTypeDef, ImageTypeDef, UpdateApplicationResultTypeDef, AppBlockTypeDef, CreateAppBlockRequestRequestTypeDef, BatchAssociateUserStackResultTypeDef, BatchDisassociateUserStackResultTypeDef, CreateDirectoryConfigResultTypeDef, DescribeDirectoryConfigsResultTypeDef, UpdateDirectoryConfigResultTypeDef, CreateEntitlementResultTypeDef, DescribeEntitlementsResultTypeDef, UpdateEntitlementResultTypeDef, CreateFleetResultTypeDef, DescribeFleetsResultTypeDef, UpdateFleetResultTypeDef, DescribeSessionsResultTypeDef, CreateImageBuilderResultTypeDef, DeleteImageBuilderResultTypeDef, DescribeImageBuildersResultTypeDef, StartImageBuilderResultTypeDef, StopImageBuilderResultTypeDef, DescribeImagePermissionsResultTypeDef, DescribeUsageReportSubscriptionsResultTypeDef, CreateStackResultTypeDef, DescribeStacksResultTypeDef, UpdateStackResultTypeDef, CreateUpdatedImageResultTypeDef, DeleteImageResultTypeDef, DescribeImagesResultTypeDef, CreateAppBlockResultTypeDef, DescribeAppBlocksResultTypeDef, ) def get_structure() -> AccessEndpointTypeDef: return {...} ``` ## How it works Fully automated [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully generates type annotations for each service, patiently waiting for `boto3` updates. It delivers a 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 the documentation (blame `botocore` docs if types are incorrect). - Type annotations include up-to-date documentation. - Link to documentation is provided for every method. - Code is processed by [black](https://github.com/psf/black) and [isort](https://github.com/PyCQA/isort) for readability. ## What's new ### Implemented features - Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries - `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` compatibility - `Client`, `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.session` calls - Auto discovery of types for `session.client` and `session.session` 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](https://github.com/youtype/mypy_boto3_builder/releases). ## Versioning `mypy-boto3-appstream` version is the same as related `boto3` version and follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. ## Thank you - [Allie Fitter](https://github.com/alliefitter) for [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), this package is based on top of his work - [black](https://github.com/psf/black) developers for an awesome formatting tool - [Timothy Edmund Crosley](https://github.com/timothycrosley) for [isort](https://github.com/PyCQA/isort) and how flexible it is - [mypy](https://github.com/python/mypy) developers for doing all dirty work for us - [pyright](https://github.com/microsoft/pyright) team for the new era of typed Python ## Documentation All services type annotations can be found in [boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_appstream/) ## Support and contributing This package is auto-generated. Please reports any bugs or request new features in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) repository. %package -n python3-mypy-boto3-appstream Summary: Type annotations for boto3.AppStream 1.26.59 service generated with mypy-boto3-builder 7.12.3 Provides: python-mypy-boto3-appstream BuildRequires: python3-devel BuildRequires: python3-setuptools BuildRequires: python3-pip %description -n python3-mypy-boto3-appstream # mypy-boto3-appstream [![PyPI - mypy-boto3-appstream](https://img.shields.io/pypi/v/mypy-boto3-appstream.svg?color=blue)](https://pypi.org/project/mypy-boto3-appstream) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-appstream.svg?color=blue)](https://pypi.org/project/mypy-boto3-appstream) [![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-appstream?color=blue)](https://pypistats.org/packages/mypy-boto3-appstream) ![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png) Type annotations for [boto3.AppStream 1.26.59](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/appstream.html#AppStream) service compatible with [VSCode](https://code.visualstudio.com/), [PyCharm](https://www.jetbrains.com/pycharm/), [Emacs](https://www.gnu.org/software/emacs/), [Sublime Text](https://www.sublimetext.com/), [mypy](https://github.com/python/mypy), [pyright](https://github.com/microsoft/pyright) and other tools. Generated by [mypy-boto3-builder 7.12.3](https://github.com/youtype/mypy_boto3_builder). More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in [mypy-boto3-appstream docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_appstream/). See how it helps to find and fix potential bugs: ![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif) - [mypy-boto3-appstream](#mypy-boto3-appstream) - [How to install](#how-to-install) - [VSCode extension](#vscode-extension) - [From PyPI with pip](#from-pypi-with-pip) - [How to uninstall](#how-to-uninstall) - [Usage](#usage) - [VSCode](#vscode) - [PyCharm](#pycharm) - [Emacs](#emacs) - [Sublime Text](#sublime-text) - [Other IDEs](#other-ides) - [mypy](#mypy) - [pyright](#pyright) - [Explicit type annotations](#explicit-type-annotations) - [Client annotations](#client-annotations) - [Paginators annotations](#paginators-annotations) - [Waiters annotations](#waiters-annotations) - [Literals](#literals) - [Typed dictionaries](#typed-dictionaries) - [How it works](#how-it-works) - [What's new](#what's-new) - [Implemented features](#implemented-features) - [Latest changes](#latest-changes) - [Versioning](#versioning) - [Thank you](#thank-you) - [Documentation](#documentation) - [Support and contributing](#support-and-contributing) ## How to install ### VSCode extension Add [AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) extension to your VSCode and run `AWS boto3: Quick Start` command. Click `Modify` and select `boto3 common` and `AppStream`. ### From PyPI with pip Install `boto3-stubs` for `AppStream` service. ```bash # install with boto3 type annotations python -m pip install 'boto3-stubs[appstream]' # Lite version does not provide session.client/resource overloads # it is more RAM-friendly, but requires explicit type annotations python -m pip install 'boto3-stubs-lite[appstream]' # standalone installation python -m pip install mypy-boto3-appstream ``` ## How to uninstall ```bash python -m pip uninstall -y mypy-boto3-appstream ``` ## Usage ### VSCode - Install [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - Install [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) - Set `Pylance` as your Python Language Server - Install `boto3-stubs[appstream]` in your environment: ```bash python -m pip install 'boto3-stubs[appstream]' ``` Both type checking and code completion should now work. No explicit type annotations required, write your `boto3` code as usual. ### PyCharm Install `boto3-stubs-lite[appstream]` in your environment: ```bash python -m pip install 'boto3-stubs-lite[appstream]'` ``` Both type checking and code completion should now work. Explicit type annotations **are required**. Use `boto3-stubs` package instead for implicit type discovery. ### Emacs - Install `boto3-stubs` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[appstream]' ``` - Install [use-package](https://github.com/jwiegley/use-package), [lsp](https://github.com/emacs-lsp/lsp-mode/), [company](https://github.com/company-mode/company-mode) and [flycheck](https://github.com/flycheck/flycheck) packages - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package ```elisp (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[appstream]` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[appstream]' ``` - Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package 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[appstream]` in your environment: ```bash python -m pip install 'boto3-stubs[appstream]'` ``` 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[appstream]` in your environment: ```bash python -m pip install 'boto3-stubs[appstream]' ``` Optionally, you can install `boto3-stubs` to `typings` folder. Type checking should now work. No explicit type annotations required, write your `boto3` code as usual. ## Explicit type annotations ### Client annotations `AppStreamClient` provides annotations for `boto3.client("appstream")`. ```python from boto3.session import Session from mypy_boto3_appstream import AppStreamClient client: AppStreamClient = Session().client("appstream") # now client usage is checked by mypy and IDE should provide code completion ``` ### Paginators annotations `mypy_boto3_appstream.paginator` module contains type annotations for all paginators. ```python from boto3.session import Session from mypy_boto3_appstream import AppStreamClient from mypy_boto3_appstream.paginator import ( DescribeDirectoryConfigsPaginator, DescribeFleetsPaginator, DescribeImageBuildersPaginator, DescribeImagesPaginator, DescribeSessionsPaginator, DescribeStacksPaginator, DescribeUserStackAssociationsPaginator, DescribeUsersPaginator, ListAssociatedFleetsPaginator, ListAssociatedStacksPaginator, ) client: AppStreamClient = Session().client("appstream") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs 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. ```python from boto3.session import Session from mypy_boto3_appstream import AppStreamClient from mypy_boto3_appstream.waiter import FleetStartedWaiter, FleetStoppedWaiter client: AppStreamClient = Session().client("appstream") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs fleet_started_waiter: FleetStartedWaiter = client.get_waiter("fleet_started") fleet_stopped_waiter: FleetStoppedWaiter = client.get_waiter("fleet_stopped") ``` ### Literals `mypy_boto3_appstream.literals` module contains literals extracted from shapes that can be used in user code for type checking. ```python from mypy_boto3_appstream.literals import ( AccessEndpointTypeType, ActionType, AppVisibilityType, ApplicationAttributeType, AuthenticationTypeType, CertificateBasedAuthStatusType, DescribeDirectoryConfigsPaginatorName, DescribeFleetsPaginatorName, DescribeImageBuildersPaginatorName, DescribeImagesPaginatorName, DescribeSessionsPaginatorName, DescribeStacksPaginatorName, DescribeUserStackAssociationsPaginatorName, DescribeUsersPaginatorName, FleetAttributeType, FleetErrorCodeType, FleetStartedWaiterName, FleetStateType, FleetStoppedWaiterName, FleetTypeType, ImageBuilderStateChangeReasonCodeType, ImageBuilderStateType, ImageStateChangeReasonCodeType, ImageStateType, ListAssociatedFleetsPaginatorName, ListAssociatedStacksPaginatorName, MessageActionType, PermissionType, PlatformTypeType, PreferredProtocolType, SessionConnectionStateType, SessionStateType, StackAttributeType, StackErrorCodeType, StorageConnectorTypeType, StreamViewType, UsageReportExecutionErrorCodeType, UsageReportScheduleType, UserStackAssociationErrorCodeType, VisibilityTypeType, AppStreamServiceName, ServiceName, ResourceServiceName, PaginatorName, WaiterName, RegionName, ) def check_value(value: AccessEndpointTypeType) -> bool: ... ``` ### Typed dictionaries `mypy_boto3_appstream.type_defs` module contains structures and shapes assembled to typed dictionaries for additional type checking. ```python from mypy_boto3_appstream.type_defs import ( AccessEndpointTypeDef, S3LocationTypeDef, ApplicationFleetAssociationTypeDef, ApplicationSettingsResponseTypeDef, ApplicationSettingsTypeDef, AssociateApplicationFleetRequestRequestTypeDef, ResponseMetadataTypeDef, AssociateApplicationToEntitlementRequestRequestTypeDef, AssociateFleetRequestRequestTypeDef, UserStackAssociationTypeDef, CertificateBasedAuthPropertiesTypeDef, ComputeCapacityStatusTypeDef, ComputeCapacityTypeDef, CopyImageRequestRequestTypeDef, ServiceAccountCredentialsTypeDef, EntitlementAttributeTypeDef, DomainJoinInfoTypeDef, VpcConfigTypeDef, CreateImageBuilderStreamingURLRequestRequestTypeDef, StorageConnectorTypeDef, StreamingExperienceSettingsTypeDef, UserSettingTypeDef, CreateStreamingURLRequestRequestTypeDef, CreateUpdatedImageRequestRequestTypeDef, CreateUserRequestRequestTypeDef, DeleteAppBlockRequestRequestTypeDef, DeleteApplicationRequestRequestTypeDef, DeleteDirectoryConfigRequestRequestTypeDef, DeleteEntitlementRequestRequestTypeDef, DeleteFleetRequestRequestTypeDef, DeleteImageBuilderRequestRequestTypeDef, DeleteImagePermissionsRequestRequestTypeDef, DeleteImageRequestRequestTypeDef, DeleteStackRequestRequestTypeDef, DeleteUserRequestRequestTypeDef, DescribeAppBlocksRequestRequestTypeDef, DescribeApplicationFleetAssociationsRequestRequestTypeDef, DescribeApplicationsRequestRequestTypeDef, PaginatorConfigTypeDef, DescribeDirectoryConfigsRequestRequestTypeDef, DescribeEntitlementsRequestRequestTypeDef, WaiterConfigTypeDef, DescribeFleetsRequestRequestTypeDef, DescribeImageBuildersRequestRequestTypeDef, DescribeImagePermissionsRequestRequestTypeDef, DescribeImagesRequestRequestTypeDef, DescribeSessionsRequestRequestTypeDef, DescribeStacksRequestRequestTypeDef, DescribeUsageReportSubscriptionsRequestRequestTypeDef, DescribeUserStackAssociationsRequestRequestTypeDef, DescribeUsersRequestRequestTypeDef, UserTypeDef, DisableUserRequestRequestTypeDef, DisassociateApplicationFleetRequestRequestTypeDef, DisassociateApplicationFromEntitlementRequestRequestTypeDef, DisassociateFleetRequestRequestTypeDef, EnableUserRequestRequestTypeDef, EntitledApplicationTypeDef, ExpireSessionRequestRequestTypeDef, FleetErrorTypeDef, ImageBuilderStateChangeReasonTypeDef, NetworkAccessConfigurationTypeDef, ResourceErrorTypeDef, ImagePermissionsTypeDef, ImageStateChangeReasonTypeDef, LastReportGenerationExecutionErrorTypeDef, ListAssociatedFleetsRequestRequestTypeDef, ListAssociatedStacksRequestRequestTypeDef, ListEntitledApplicationsRequestRequestTypeDef, ListTagsForResourceRequestRequestTypeDef, StackErrorTypeDef, StartFleetRequestRequestTypeDef, StartImageBuilderRequestRequestTypeDef, StopFleetRequestRequestTypeDef, StopImageBuilderRequestRequestTypeDef, TagResourceRequestRequestTypeDef, UntagResourceRequestRequestTypeDef, ApplicationTypeDef, CreateApplicationRequestRequestTypeDef, ScriptDetailsTypeDef, UpdateApplicationRequestRequestTypeDef, AssociateApplicationFleetResultTypeDef, CopyImageResponseTypeDef, CreateImageBuilderStreamingURLResultTypeDef, CreateStreamingURLResultTypeDef, CreateUsageReportSubscriptionResultTypeDef, DescribeApplicationFleetAssociationsResultTypeDef, ListAssociatedFleetsResultTypeDef, ListAssociatedStacksResultTypeDef, ListTagsForResourceResponseTypeDef, BatchAssociateUserStackRequestRequestTypeDef, BatchDisassociateUserStackRequestRequestTypeDef, DescribeUserStackAssociationsResultTypeDef, UserStackAssociationErrorTypeDef, CreateDirectoryConfigRequestRequestTypeDef, DirectoryConfigTypeDef, UpdateDirectoryConfigRequestRequestTypeDef, CreateEntitlementRequestRequestTypeDef, EntitlementTypeDef, UpdateEntitlementRequestRequestTypeDef, CreateFleetRequestRequestTypeDef, CreateImageBuilderRequestRequestTypeDef, UpdateFleetRequestRequestTypeDef, CreateStackRequestRequestTypeDef, UpdateStackRequestRequestTypeDef, DescribeDirectoryConfigsRequestDescribeDirectoryConfigsPaginateTypeDef, DescribeFleetsRequestDescribeFleetsPaginateTypeDef, DescribeImageBuildersRequestDescribeImageBuildersPaginateTypeDef, DescribeImagesRequestDescribeImagesPaginateTypeDef, DescribeSessionsRequestDescribeSessionsPaginateTypeDef, DescribeStacksRequestDescribeStacksPaginateTypeDef, DescribeUserStackAssociationsRequestDescribeUserStackAssociationsPaginateTypeDef, DescribeUsersRequestDescribeUsersPaginateTypeDef, ListAssociatedFleetsRequestListAssociatedFleetsPaginateTypeDef, ListAssociatedStacksRequestListAssociatedStacksPaginateTypeDef, DescribeFleetsRequestFleetStartedWaitTypeDef, DescribeFleetsRequestFleetStoppedWaitTypeDef, DescribeUsersResultTypeDef, ListEntitledApplicationsResultTypeDef, FleetTypeDef, SessionTypeDef, ImageBuilderTypeDef, SharedImagePermissionsTypeDef, UpdateImagePermissionsRequestRequestTypeDef, UsageReportSubscriptionTypeDef, StackTypeDef, CreateApplicationResultTypeDef, DescribeApplicationsResultTypeDef, ImageTypeDef, UpdateApplicationResultTypeDef, AppBlockTypeDef, CreateAppBlockRequestRequestTypeDef, BatchAssociateUserStackResultTypeDef, BatchDisassociateUserStackResultTypeDef, CreateDirectoryConfigResultTypeDef, DescribeDirectoryConfigsResultTypeDef, UpdateDirectoryConfigResultTypeDef, CreateEntitlementResultTypeDef, DescribeEntitlementsResultTypeDef, UpdateEntitlementResultTypeDef, CreateFleetResultTypeDef, DescribeFleetsResultTypeDef, UpdateFleetResultTypeDef, DescribeSessionsResultTypeDef, CreateImageBuilderResultTypeDef, DeleteImageBuilderResultTypeDef, DescribeImageBuildersResultTypeDef, StartImageBuilderResultTypeDef, StopImageBuilderResultTypeDef, DescribeImagePermissionsResultTypeDef, DescribeUsageReportSubscriptionsResultTypeDef, CreateStackResultTypeDef, DescribeStacksResultTypeDef, UpdateStackResultTypeDef, CreateUpdatedImageResultTypeDef, DeleteImageResultTypeDef, DescribeImagesResultTypeDef, CreateAppBlockResultTypeDef, DescribeAppBlocksResultTypeDef, ) def get_structure() -> AccessEndpointTypeDef: return {...} ``` ## How it works Fully automated [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully generates type annotations for each service, patiently waiting for `boto3` updates. It delivers a 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 the documentation (blame `botocore` docs if types are incorrect). - Type annotations include up-to-date documentation. - Link to documentation is provided for every method. - Code is processed by [black](https://github.com/psf/black) and [isort](https://github.com/PyCQA/isort) for readability. ## What's new ### Implemented features - Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries - `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` compatibility - `Client`, `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.session` calls - Auto discovery of types for `session.client` and `session.session` 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](https://github.com/youtype/mypy_boto3_builder/releases). ## Versioning `mypy-boto3-appstream` version is the same as related `boto3` version and follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. ## Thank you - [Allie Fitter](https://github.com/alliefitter) for [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), this package is based on top of his work - [black](https://github.com/psf/black) developers for an awesome formatting tool - [Timothy Edmund Crosley](https://github.com/timothycrosley) for [isort](https://github.com/PyCQA/isort) and how flexible it is - [mypy](https://github.com/python/mypy) developers for doing all dirty work for us - [pyright](https://github.com/microsoft/pyright) team for the new era of typed Python ## Documentation All services type annotations can be found in [boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_appstream/) ## Support and contributing This package is auto-generated. Please reports any bugs or request new features in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) repository. %package help Summary: Development documents and examples for mypy-boto3-appstream Provides: python3-mypy-boto3-appstream-doc %description help # mypy-boto3-appstream [![PyPI - mypy-boto3-appstream](https://img.shields.io/pypi/v/mypy-boto3-appstream.svg?color=blue)](https://pypi.org/project/mypy-boto3-appstream) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-appstream.svg?color=blue)](https://pypi.org/project/mypy-boto3-appstream) [![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-appstream?color=blue)](https://pypistats.org/packages/mypy-boto3-appstream) ![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png) Type annotations for [boto3.AppStream 1.26.59](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/appstream.html#AppStream) service compatible with [VSCode](https://code.visualstudio.com/), [PyCharm](https://www.jetbrains.com/pycharm/), [Emacs](https://www.gnu.org/software/emacs/), [Sublime Text](https://www.sublimetext.com/), [mypy](https://github.com/python/mypy), [pyright](https://github.com/microsoft/pyright) and other tools. Generated by [mypy-boto3-builder 7.12.3](https://github.com/youtype/mypy_boto3_builder). More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in [mypy-boto3-appstream docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_appstream/). See how it helps to find and fix potential bugs: ![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif) - [mypy-boto3-appstream](#mypy-boto3-appstream) - [How to install](#how-to-install) - [VSCode extension](#vscode-extension) - [From PyPI with pip](#from-pypi-with-pip) - [How to uninstall](#how-to-uninstall) - [Usage](#usage) - [VSCode](#vscode) - [PyCharm](#pycharm) - [Emacs](#emacs) - [Sublime Text](#sublime-text) - [Other IDEs](#other-ides) - [mypy](#mypy) - [pyright](#pyright) - [Explicit type annotations](#explicit-type-annotations) - [Client annotations](#client-annotations) - [Paginators annotations](#paginators-annotations) - [Waiters annotations](#waiters-annotations) - [Literals](#literals) - [Typed dictionaries](#typed-dictionaries) - [How it works](#how-it-works) - [What's new](#what's-new) - [Implemented features](#implemented-features) - [Latest changes](#latest-changes) - [Versioning](#versioning) - [Thank you](#thank-you) - [Documentation](#documentation) - [Support and contributing](#support-and-contributing) ## How to install ### VSCode extension Add [AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) extension to your VSCode and run `AWS boto3: Quick Start` command. Click `Modify` and select `boto3 common` and `AppStream`. ### From PyPI with pip Install `boto3-stubs` for `AppStream` service. ```bash # install with boto3 type annotations python -m pip install 'boto3-stubs[appstream]' # Lite version does not provide session.client/resource overloads # it is more RAM-friendly, but requires explicit type annotations python -m pip install 'boto3-stubs-lite[appstream]' # standalone installation python -m pip install mypy-boto3-appstream ``` ## How to uninstall ```bash python -m pip uninstall -y mypy-boto3-appstream ``` ## Usage ### VSCode - Install [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - Install [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) - Set `Pylance` as your Python Language Server - Install `boto3-stubs[appstream]` in your environment: ```bash python -m pip install 'boto3-stubs[appstream]' ``` Both type checking and code completion should now work. No explicit type annotations required, write your `boto3` code as usual. ### PyCharm Install `boto3-stubs-lite[appstream]` in your environment: ```bash python -m pip install 'boto3-stubs-lite[appstream]'` ``` Both type checking and code completion should now work. Explicit type annotations **are required**. Use `boto3-stubs` package instead for implicit type discovery. ### Emacs - Install `boto3-stubs` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[appstream]' ``` - Install [use-package](https://github.com/jwiegley/use-package), [lsp](https://github.com/emacs-lsp/lsp-mode/), [company](https://github.com/company-mode/company-mode) and [flycheck](https://github.com/flycheck/flycheck) packages - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package ```elisp (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[appstream]` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[appstream]' ``` - Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package 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[appstream]` in your environment: ```bash python -m pip install 'boto3-stubs[appstream]'` ``` 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[appstream]` in your environment: ```bash python -m pip install 'boto3-stubs[appstream]' ``` Optionally, you can install `boto3-stubs` to `typings` folder. Type checking should now work. No explicit type annotations required, write your `boto3` code as usual. ## Explicit type annotations ### Client annotations `AppStreamClient` provides annotations for `boto3.client("appstream")`. ```python from boto3.session import Session from mypy_boto3_appstream import AppStreamClient client: AppStreamClient = Session().client("appstream") # now client usage is checked by mypy and IDE should provide code completion ``` ### Paginators annotations `mypy_boto3_appstream.paginator` module contains type annotations for all paginators. ```python from boto3.session import Session from mypy_boto3_appstream import AppStreamClient from mypy_boto3_appstream.paginator import ( DescribeDirectoryConfigsPaginator, DescribeFleetsPaginator, DescribeImageBuildersPaginator, DescribeImagesPaginator, DescribeSessionsPaginator, DescribeStacksPaginator, DescribeUserStackAssociationsPaginator, DescribeUsersPaginator, ListAssociatedFleetsPaginator, ListAssociatedStacksPaginator, ) client: AppStreamClient = Session().client("appstream") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs 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. ```python from boto3.session import Session from mypy_boto3_appstream import AppStreamClient from mypy_boto3_appstream.waiter import FleetStartedWaiter, FleetStoppedWaiter client: AppStreamClient = Session().client("appstream") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs fleet_started_waiter: FleetStartedWaiter = client.get_waiter("fleet_started") fleet_stopped_waiter: FleetStoppedWaiter = client.get_waiter("fleet_stopped") ``` ### Literals `mypy_boto3_appstream.literals` module contains literals extracted from shapes that can be used in user code for type checking. ```python from mypy_boto3_appstream.literals import ( AccessEndpointTypeType, ActionType, AppVisibilityType, ApplicationAttributeType, AuthenticationTypeType, CertificateBasedAuthStatusType, DescribeDirectoryConfigsPaginatorName, DescribeFleetsPaginatorName, DescribeImageBuildersPaginatorName, DescribeImagesPaginatorName, DescribeSessionsPaginatorName, DescribeStacksPaginatorName, DescribeUserStackAssociationsPaginatorName, DescribeUsersPaginatorName, FleetAttributeType, FleetErrorCodeType, FleetStartedWaiterName, FleetStateType, FleetStoppedWaiterName, FleetTypeType, ImageBuilderStateChangeReasonCodeType, ImageBuilderStateType, ImageStateChangeReasonCodeType, ImageStateType, ListAssociatedFleetsPaginatorName, ListAssociatedStacksPaginatorName, MessageActionType, PermissionType, PlatformTypeType, PreferredProtocolType, SessionConnectionStateType, SessionStateType, StackAttributeType, StackErrorCodeType, StorageConnectorTypeType, StreamViewType, UsageReportExecutionErrorCodeType, UsageReportScheduleType, UserStackAssociationErrorCodeType, VisibilityTypeType, AppStreamServiceName, ServiceName, ResourceServiceName, PaginatorName, WaiterName, RegionName, ) def check_value(value: AccessEndpointTypeType) -> bool: ... ``` ### Typed dictionaries `mypy_boto3_appstream.type_defs` module contains structures and shapes assembled to typed dictionaries for additional type checking. ```python from mypy_boto3_appstream.type_defs import ( AccessEndpointTypeDef, S3LocationTypeDef, ApplicationFleetAssociationTypeDef, ApplicationSettingsResponseTypeDef, ApplicationSettingsTypeDef, AssociateApplicationFleetRequestRequestTypeDef, ResponseMetadataTypeDef, AssociateApplicationToEntitlementRequestRequestTypeDef, AssociateFleetRequestRequestTypeDef, UserStackAssociationTypeDef, CertificateBasedAuthPropertiesTypeDef, ComputeCapacityStatusTypeDef, ComputeCapacityTypeDef, CopyImageRequestRequestTypeDef, ServiceAccountCredentialsTypeDef, EntitlementAttributeTypeDef, DomainJoinInfoTypeDef, VpcConfigTypeDef, CreateImageBuilderStreamingURLRequestRequestTypeDef, StorageConnectorTypeDef, StreamingExperienceSettingsTypeDef, UserSettingTypeDef, CreateStreamingURLRequestRequestTypeDef, CreateUpdatedImageRequestRequestTypeDef, CreateUserRequestRequestTypeDef, DeleteAppBlockRequestRequestTypeDef, DeleteApplicationRequestRequestTypeDef, DeleteDirectoryConfigRequestRequestTypeDef, DeleteEntitlementRequestRequestTypeDef, DeleteFleetRequestRequestTypeDef, DeleteImageBuilderRequestRequestTypeDef, DeleteImagePermissionsRequestRequestTypeDef, DeleteImageRequestRequestTypeDef, DeleteStackRequestRequestTypeDef, DeleteUserRequestRequestTypeDef, DescribeAppBlocksRequestRequestTypeDef, DescribeApplicationFleetAssociationsRequestRequestTypeDef, DescribeApplicationsRequestRequestTypeDef, PaginatorConfigTypeDef, DescribeDirectoryConfigsRequestRequestTypeDef, DescribeEntitlementsRequestRequestTypeDef, WaiterConfigTypeDef, DescribeFleetsRequestRequestTypeDef, DescribeImageBuildersRequestRequestTypeDef, DescribeImagePermissionsRequestRequestTypeDef, DescribeImagesRequestRequestTypeDef, DescribeSessionsRequestRequestTypeDef, DescribeStacksRequestRequestTypeDef, DescribeUsageReportSubscriptionsRequestRequestTypeDef, DescribeUserStackAssociationsRequestRequestTypeDef, DescribeUsersRequestRequestTypeDef, UserTypeDef, DisableUserRequestRequestTypeDef, DisassociateApplicationFleetRequestRequestTypeDef, DisassociateApplicationFromEntitlementRequestRequestTypeDef, DisassociateFleetRequestRequestTypeDef, EnableUserRequestRequestTypeDef, EntitledApplicationTypeDef, ExpireSessionRequestRequestTypeDef, FleetErrorTypeDef, ImageBuilderStateChangeReasonTypeDef, NetworkAccessConfigurationTypeDef, ResourceErrorTypeDef, ImagePermissionsTypeDef, ImageStateChangeReasonTypeDef, LastReportGenerationExecutionErrorTypeDef, ListAssociatedFleetsRequestRequestTypeDef, ListAssociatedStacksRequestRequestTypeDef, ListEntitledApplicationsRequestRequestTypeDef, ListTagsForResourceRequestRequestTypeDef, StackErrorTypeDef, StartFleetRequestRequestTypeDef, StartImageBuilderRequestRequestTypeDef, StopFleetRequestRequestTypeDef, StopImageBuilderRequestRequestTypeDef, TagResourceRequestRequestTypeDef, UntagResourceRequestRequestTypeDef, ApplicationTypeDef, CreateApplicationRequestRequestTypeDef, ScriptDetailsTypeDef, UpdateApplicationRequestRequestTypeDef, AssociateApplicationFleetResultTypeDef, CopyImageResponseTypeDef, CreateImageBuilderStreamingURLResultTypeDef, CreateStreamingURLResultTypeDef, CreateUsageReportSubscriptionResultTypeDef, DescribeApplicationFleetAssociationsResultTypeDef, ListAssociatedFleetsResultTypeDef, ListAssociatedStacksResultTypeDef, ListTagsForResourceResponseTypeDef, BatchAssociateUserStackRequestRequestTypeDef, BatchDisassociateUserStackRequestRequestTypeDef, DescribeUserStackAssociationsResultTypeDef, UserStackAssociationErrorTypeDef, CreateDirectoryConfigRequestRequestTypeDef, DirectoryConfigTypeDef, UpdateDirectoryConfigRequestRequestTypeDef, CreateEntitlementRequestRequestTypeDef, EntitlementTypeDef, UpdateEntitlementRequestRequestTypeDef, CreateFleetRequestRequestTypeDef, CreateImageBuilderRequestRequestTypeDef, UpdateFleetRequestRequestTypeDef, CreateStackRequestRequestTypeDef, UpdateStackRequestRequestTypeDef, DescribeDirectoryConfigsRequestDescribeDirectoryConfigsPaginateTypeDef, DescribeFleetsRequestDescribeFleetsPaginateTypeDef, DescribeImageBuildersRequestDescribeImageBuildersPaginateTypeDef, DescribeImagesRequestDescribeImagesPaginateTypeDef, DescribeSessionsRequestDescribeSessionsPaginateTypeDef, DescribeStacksRequestDescribeStacksPaginateTypeDef, DescribeUserStackAssociationsRequestDescribeUserStackAssociationsPaginateTypeDef, DescribeUsersRequestDescribeUsersPaginateTypeDef, ListAssociatedFleetsRequestListAssociatedFleetsPaginateTypeDef, ListAssociatedStacksRequestListAssociatedStacksPaginateTypeDef, DescribeFleetsRequestFleetStartedWaitTypeDef, DescribeFleetsRequestFleetStoppedWaitTypeDef, DescribeUsersResultTypeDef, ListEntitledApplicationsResultTypeDef, FleetTypeDef, SessionTypeDef, ImageBuilderTypeDef, SharedImagePermissionsTypeDef, UpdateImagePermissionsRequestRequestTypeDef, UsageReportSubscriptionTypeDef, StackTypeDef, CreateApplicationResultTypeDef, DescribeApplicationsResultTypeDef, ImageTypeDef, UpdateApplicationResultTypeDef, AppBlockTypeDef, CreateAppBlockRequestRequestTypeDef, BatchAssociateUserStackResultTypeDef, BatchDisassociateUserStackResultTypeDef, CreateDirectoryConfigResultTypeDef, DescribeDirectoryConfigsResultTypeDef, UpdateDirectoryConfigResultTypeDef, CreateEntitlementResultTypeDef, DescribeEntitlementsResultTypeDef, UpdateEntitlementResultTypeDef, CreateFleetResultTypeDef, DescribeFleetsResultTypeDef, UpdateFleetResultTypeDef, DescribeSessionsResultTypeDef, CreateImageBuilderResultTypeDef, DeleteImageBuilderResultTypeDef, DescribeImageBuildersResultTypeDef, StartImageBuilderResultTypeDef, StopImageBuilderResultTypeDef, DescribeImagePermissionsResultTypeDef, DescribeUsageReportSubscriptionsResultTypeDef, CreateStackResultTypeDef, DescribeStacksResultTypeDef, UpdateStackResultTypeDef, CreateUpdatedImageResultTypeDef, DeleteImageResultTypeDef, DescribeImagesResultTypeDef, CreateAppBlockResultTypeDef, DescribeAppBlocksResultTypeDef, ) def get_structure() -> AccessEndpointTypeDef: return {...} ``` ## How it works Fully automated [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully generates type annotations for each service, patiently waiting for `boto3` updates. It delivers a 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 the documentation (blame `botocore` docs if types are incorrect). - Type annotations include up-to-date documentation. - Link to documentation is provided for every method. - Code is processed by [black](https://github.com/psf/black) and [isort](https://github.com/PyCQA/isort) for readability. ## What's new ### Implemented features - Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries - `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` compatibility - `Client`, `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.session` calls - Auto discovery of types for `session.client` and `session.session` 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](https://github.com/youtype/mypy_boto3_builder/releases). ## Versioning `mypy-boto3-appstream` version is the same as related `boto3` version and follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. ## Thank you - [Allie Fitter](https://github.com/alliefitter) for [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), this package is based on top of his work - [black](https://github.com/psf/black) developers for an awesome formatting tool - [Timothy Edmund Crosley](https://github.com/timothycrosley) for [isort](https://github.com/PyCQA/isort) and how flexible it is - [mypy](https://github.com/python/mypy) developers for doing all dirty work for us - [pyright](https://github.com/microsoft/pyright) team for the new era of typed Python ## Documentation All services type annotations can be found in [boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_appstream/) ## Support and contributing This package is auto-generated. Please reports any bugs or request new features in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) repository. %prep %autosetup -n mypy-boto3-appstream-1.26.59 %build %py3_build %install %py3_install install -d -m755 %{buildroot}/%{_pkgdocdir} if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi pushd %{buildroot} if [ -d usr/lib ]; then find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst fi if [ -d usr/lib64 ]; then find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst fi if [ -d usr/bin ]; then find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst fi if [ -d usr/sbin ]; then find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst fi touch doclist.lst if [ -d usr/share/man ]; then find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst fi popd mv %{buildroot}/filelist.lst . mv %{buildroot}/doclist.lst . %files -n python3-mypy-boto3-appstream -f filelist.lst %dir %{python3_sitelib}/* %files help -f doclist.lst %{_docdir}/* %changelog * Tue Apr 11 2023 Python_Bot - 1.26.59-1 - Package Spec generated