%global _empty_manifest_terminate_build 0 Name: python-mypy-boto3-nimble Version: 1.26.34 Release: 1 Summary: Type annotations for boto3.NimbleStudio 1.26.34 service generated with mypy-boto3-builder 7.12.0 License: MIT License URL: https://github.com/youtype/mypy_boto3_builder Source0: https://mirrors.nju.edu.cn/pypi/web/packages/3e/49/d445572b13d91c59b8a8fa255aa01452bc47f928d291240960e16a50e11b/mypy-boto3-nimble-1.26.34.tar.gz BuildArch: noarch Requires: python3-typing-extensions %description <a id="mypy-boto3-nimble"></a> # mypy-boto3-nimble [](https://pypi.org/project/mypy-boto3-nimble) [](https://pypi.org/project/mypy-boto3-nimble) [](https://mypy-boto3-builder.readthedocs.io/) [](https://pypistats.org/packages/mypy-boto3-nimble)  Type annotations for [boto3.NimbleStudio 1.26.34](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/nimble.html#NimbleStudio) 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.0](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-nimble docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_nimble/). See how it helps to find and fix potential bugs:  - [mypy-boto3-nimble](#mypy-boto3-nimble) - [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) <a id="how-to-install"></a> ## How to install <a id="vscode-extension"></a> ### 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 `NimbleStudio`. <a id="from-pypi-with-pip"></a> ### From PyPI with pip Install `boto3-stubs` for `NimbleStudio` service. ```bash # install with boto3 type annotations python -m pip install 'boto3-stubs[nimble]' # 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[nimble]' # standalone installation python -m pip install mypy-boto3-nimble ``` <a id="how-to-uninstall"></a> ## How to uninstall ```bash python -m pip uninstall -y mypy-boto3-nimble ``` <a id="usage"></a> ## Usage <a id="vscode"></a> ### 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[nimble]` in your environment: ```bash python -m pip install 'boto3-stubs[nimble]' ``` Both type checking and code completion should now work. No explicit type annotations required, write your `boto3` code as usual. <a id="pycharm"></a> ### PyCharm Install `boto3-stubs-lite[nimble]` in your environment: ```bash python -m pip install 'boto3-stubs-lite[nimble]'` ``` Both type checking and code completion should now work. Explicit type annotations **are required**. Use `boto3-stubs` package instead for implicit type discovery. <a id="emacs"></a> ### Emacs - Install `boto3-stubs` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[nimble]' ``` - 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. <a id="sublime-text"></a> ### Sublime Text - Install `boto3-stubs[nimble]` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[nimble]' ``` - 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. <a id="other-ides"></a> ### Other IDEs Not tested, but as long as your IDE supports `mypy` or `pyright`, everything should work. <a id="mypy"></a> ### mypy - Install `mypy`: `python -m pip install mypy` - Install `boto3-stubs[nimble]` in your environment: ```bash python -m pip install 'boto3-stubs[nimble]'` ``` Type checking should now work. No explicit type annotations required, write your `boto3` code as usual. <a id="pyright"></a> ### pyright - Install `pyright`: `npm i -g pyright` - Install `boto3-stubs[nimble]` in your environment: ```bash python -m pip install 'boto3-stubs[nimble]' ``` 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. <a id="explicit-type-annotations"></a> ## Explicit type annotations <a id="client-annotations"></a> ### Client annotations `NimbleStudioClient` provides annotations for `boto3.client("nimble")`. ```python from boto3.session import Session from mypy_boto3_nimble import NimbleStudioClient client: NimbleStudioClient = Session().client("nimble") # now client usage is checked by mypy and IDE should provide code completion ``` <a id="paginators-annotations"></a> ### Paginators annotations `mypy_boto3_nimble.paginator` module contains type annotations for all paginators. ```python from boto3.session import Session from mypy_boto3_nimble import NimbleStudioClient from mypy_boto3_nimble.paginator import ( ListEulaAcceptancesPaginator, ListEulasPaginator, ListLaunchProfileMembersPaginator, ListLaunchProfilesPaginator, ListStreamingImagesPaginator, ListStreamingSessionBackupsPaginator, ListStreamingSessionsPaginator, ListStudioComponentsPaginator, ListStudioMembersPaginator, ListStudiosPaginator, ) client: NimbleStudioClient = Session().client("nimble") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs list_eula_acceptances_paginator: ListEulaAcceptancesPaginator = client.get_paginator( "list_eula_acceptances" ) list_eulas_paginator: ListEulasPaginator = client.get_paginator("list_eulas") list_launch_profile_members_paginator: ListLaunchProfileMembersPaginator = client.get_paginator( "list_launch_profile_members" ) list_launch_profiles_paginator: ListLaunchProfilesPaginator = client.get_paginator( "list_launch_profiles" ) list_streaming_images_paginator: ListStreamingImagesPaginator = client.get_paginator( "list_streaming_images" ) list_streaming_session_backups_paginator: ListStreamingSessionBackupsPaginator = ( client.get_paginator("list_streaming_session_backups") ) list_streaming_sessions_paginator: ListStreamingSessionsPaginator = client.get_paginator( "list_streaming_sessions" ) list_studio_components_paginator: ListStudioComponentsPaginator = client.get_paginator( "list_studio_components" ) list_studio_members_paginator: ListStudioMembersPaginator = client.get_paginator( "list_studio_members" ) list_studios_paginator: ListStudiosPaginator = client.get_paginator("list_studios") ``` <a id="waiters-annotations"></a> ### Waiters annotations `mypy_boto3_nimble.waiter` module contains type annotations for all waiters. ```python from boto3.session import Session from mypy_boto3_nimble import NimbleStudioClient from mypy_boto3_nimble.waiter import ( LaunchProfileDeletedWaiter, LaunchProfileReadyWaiter, StreamingImageDeletedWaiter, StreamingImageReadyWaiter, StreamingSessionDeletedWaiter, StreamingSessionReadyWaiter, StreamingSessionStoppedWaiter, StreamingSessionStreamReadyWaiter, StudioComponentDeletedWaiter, StudioComponentReadyWaiter, StudioDeletedWaiter, StudioReadyWaiter, ) client: NimbleStudioClient = Session().client("nimble") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs launch_profile_deleted_waiter: LaunchProfileDeletedWaiter = client.get_waiter( "launch_profile_deleted" ) launch_profile_ready_waiter: LaunchProfileReadyWaiter = client.get_waiter("launch_profile_ready") streaming_image_deleted_waiter: StreamingImageDeletedWaiter = client.get_waiter( "streaming_image_deleted" ) streaming_image_ready_waiter: StreamingImageReadyWaiter = client.get_waiter("streaming_image_ready") streaming_session_deleted_waiter: StreamingSessionDeletedWaiter = client.get_waiter( "streaming_session_deleted" ) streaming_session_ready_waiter: StreamingSessionReadyWaiter = client.get_waiter( "streaming_session_ready" ) streaming_session_stopped_waiter: StreamingSessionStoppedWaiter = client.get_waiter( "streaming_session_stopped" ) streaming_session_stream_ready_waiter: StreamingSessionStreamReadyWaiter = client.get_waiter( "streaming_session_stream_ready" ) studio_component_deleted_waiter: StudioComponentDeletedWaiter = client.get_waiter( "studio_component_deleted" ) studio_component_ready_waiter: StudioComponentReadyWaiter = client.get_waiter( "studio_component_ready" ) studio_deleted_waiter: StudioDeletedWaiter = client.get_waiter("studio_deleted") studio_ready_waiter: StudioReadyWaiter = client.get_waiter("studio_ready") ``` <a id="literals"></a> ### Literals `mypy_boto3_nimble.literals` module contains literals extracted from shapes that can be used in user code for type checking. ```python from mypy_boto3_nimble.literals import ( AutomaticTerminationModeType, LaunchProfileDeletedWaiterName, LaunchProfilePersonaType, LaunchProfilePlatformType, LaunchProfileReadyWaiterName, LaunchProfileStateType, LaunchProfileStatusCodeType, LaunchProfileValidationStateType, LaunchProfileValidationStatusCodeType, LaunchProfileValidationTypeType, ListEulaAcceptancesPaginatorName, ListEulasPaginatorName, ListLaunchProfileMembersPaginatorName, ListLaunchProfilesPaginatorName, ListStreamingImagesPaginatorName, ListStreamingSessionBackupsPaginatorName, ListStreamingSessionsPaginatorName, ListStudioComponentsPaginatorName, ListStudioMembersPaginatorName, ListStudiosPaginatorName, SessionBackupModeType, SessionPersistenceModeType, StreamingClipboardModeType, StreamingImageDeletedWaiterName, StreamingImageEncryptionConfigurationKeyTypeType, StreamingImageReadyWaiterName, StreamingImageStateType, StreamingImageStatusCodeType, StreamingInstanceTypeType, StreamingSessionDeletedWaiterName, StreamingSessionReadyWaiterName, StreamingSessionStateType, StreamingSessionStatusCodeType, StreamingSessionStoppedWaiterName, StreamingSessionStorageModeType, StreamingSessionStreamReadyWaiterName, StreamingSessionStreamStateType, StreamingSessionStreamStatusCodeType, StudioComponentDeletedWaiterName, StudioComponentInitializationScriptRunContextType, StudioComponentReadyWaiterName, StudioComponentStateType, StudioComponentStatusCodeType, StudioComponentSubtypeType, StudioComponentTypeType, StudioDeletedWaiterName, StudioEncryptionConfigurationKeyTypeType, StudioPersonaType, StudioReadyWaiterName, StudioStateType, StudioStatusCodeType, VolumeRetentionModeType, NimbleStudioServiceName, ServiceName, ResourceServiceName, PaginatorName, WaiterName, RegionName, ) def check_value(value: AutomaticTerminationModeType) -> bool: ... ``` <a id="typed-dictionaries"></a> ### Typed dictionaries `mypy_boto3_nimble.type_defs` module contains structures and shapes assembled to typed dictionaries for additional type checking. ```python from mypy_boto3_nimble.type_defs import ( AcceptEulasRequestRequestTypeDef, EulaAcceptanceTypeDef, ResponseMetadataTypeDef, ActiveDirectoryComputerAttributeTypeDef, ComputeFarmConfigurationTypeDef, CreateStreamingImageRequestRequestTypeDef, CreateStreamingSessionRequestRequestTypeDef, CreateStreamingSessionStreamRequestRequestTypeDef, StreamingSessionStreamTypeDef, ScriptParameterKeyValueTypeDef, StudioComponentInitializationScriptTypeDef, StudioEncryptionConfigurationTypeDef, DeleteLaunchProfileMemberRequestRequestTypeDef, DeleteLaunchProfileRequestRequestTypeDef, DeleteStreamingImageRequestRequestTypeDef, DeleteStreamingSessionRequestRequestTypeDef, DeleteStudioComponentRequestRequestTypeDef, DeleteStudioMemberRequestRequestTypeDef, DeleteStudioRequestRequestTypeDef, EulaTypeDef, GetEulaRequestRequestTypeDef, GetLaunchProfileDetailsRequestRequestTypeDef, StudioComponentSummaryTypeDef, GetLaunchProfileInitializationRequestRequestTypeDef, GetLaunchProfileMemberRequestRequestTypeDef, LaunchProfileMembershipTypeDef, WaiterConfigTypeDef, GetLaunchProfileRequestRequestTypeDef, GetStreamingImageRequestRequestTypeDef, GetStreamingSessionBackupRequestRequestTypeDef, StreamingSessionBackupTypeDef, GetStreamingSessionRequestRequestTypeDef, GetStreamingSessionStreamRequestRequestTypeDef, GetStudioComponentRequestRequestTypeDef, GetStudioMemberRequestRequestTypeDef, StudioMembershipTypeDef, GetStudioRequestRequestTypeDef, LaunchProfileInitializationScriptTypeDef, ValidationResultTypeDef, LicenseServiceConfigurationTypeDef, PaginatorConfigTypeDef, ListEulaAcceptancesRequestRequestTypeDef, ListEulasRequestRequestTypeDef, ListLaunchProfileMembersRequestRequestTypeDef, ListLaunchProfilesRequestRequestTypeDef, ListStreamingImagesRequestRequestTypeDef, ListStreamingSessionBackupsRequestRequestTypeDef, ListStreamingSessionsRequestRequestTypeDef, ListStudioComponentsRequestRequestTypeDef, ListStudioMembersRequestRequestTypeDef, ListStudiosRequestRequestTypeDef, ListTagsForResourceRequestRequestTypeDef, NewLaunchProfileMemberTypeDef, NewStudioMemberTypeDef, SharedFileSystemConfigurationTypeDef, StartStreamingSessionRequestRequestTypeDef, StartStudioSSOConfigurationRepairRequestRequestTypeDef, StopStreamingSessionRequestRequestTypeDef, StreamConfigurationSessionBackupTypeDef, VolumeConfigurationTypeDef, StreamingSessionStorageRootTypeDef, StreamingImageEncryptionConfigurationTypeDef, TagResourceRequestRequestTypeDef, UntagResourceRequestRequestTypeDef, UpdateLaunchProfileMemberRequestRequestTypeDef, UpdateStreamingImageRequestRequestTypeDef, UpdateStudioRequestRequestTypeDef, AcceptEulasResponseTypeDef, ListEulaAcceptancesResponseTypeDef, ListTagsForResourceResponseTypeDef, ActiveDirectoryConfigurationTypeDef, LaunchProfileInitializationActiveDirectoryTypeDef, CreateStreamingSessionStreamResponseTypeDef, GetStreamingSessionStreamResponseTypeDef, CreateStudioRequestRequestTypeDef, StudioTypeDef, GetEulaResponseTypeDef, ListEulasResponseTypeDef, GetLaunchProfileMemberResponseTypeDef, ListLaunchProfileMembersResponseTypeDef, UpdateLaunchProfileMemberResponseTypeDef, GetLaunchProfileRequestLaunchProfileDeletedWaitTypeDef, GetLaunchProfileRequestLaunchProfileReadyWaitTypeDef, GetStreamingImageRequestStreamingImageDeletedWaitTypeDef, GetStreamingImageRequestStreamingImageReadyWaitTypeDef, GetStreamingSessionRequestStreamingSessionDeletedWaitTypeDef, GetStreamingSessionRequestStreamingSessionReadyWaitTypeDef, GetStreamingSessionRequestStreamingSessionStoppedWaitTypeDef, GetStreamingSessionStreamRequestStreamingSessionStreamReadyWaitTypeDef, GetStudioComponentRequestStudioComponentDeletedWaitTypeDef, GetStudioComponentRequestStudioComponentReadyWaitTypeDef, GetStudioRequestStudioDeletedWaitTypeDef, GetStudioRequestStudioReadyWaitTypeDef, GetStreamingSessionBackupResponseTypeDef, ListStreamingSessionBackupsResponseTypeDef, GetStudioMemberResponseTypeDef, ListStudioMembersResponseTypeDef, ListEulaAcceptancesRequestListEulaAcceptancesPaginateTypeDef, ListEulasRequestListEulasPaginateTypeDef, ListLaunchProfileMembersRequestListLaunchProfileMembersPaginateTypeDef, ListLaunchProfilesRequestListLaunchProfilesPaginateTypeDef, ListStreamingImagesRequestListStreamingImagesPaginateTypeDef, ListStreamingSessionBackupsRequestListStreamingSessionBackupsPaginateTypeDef, ListStreamingSessionsRequestListStreamingSessionsPaginateTypeDef, ListStudioComponentsRequestListStudioComponentsPaginateTypeDef, ListStudioMembersRequestListStudioMembersPaginateTypeDef, ListStudiosRequestListStudiosPaginateTypeDef, PutLaunchProfileMembersRequestRequestTypeDef, PutStudioMembersRequestRequestTypeDef, StreamingSessionTypeDef, StreamConfigurationSessionStorageTypeDef, StreamingImageTypeDef, StudioComponentConfigurationTypeDef, LaunchProfileInitializationTypeDef, CreateStudioResponseTypeDef, DeleteStudioResponseTypeDef, GetStudioResponseTypeDef, ListStudiosResponseTypeDef, StartStudioSSOConfigurationRepairResponseTypeDef, UpdateStudioResponseTypeDef, CreateStreamingSessionResponseTypeDef, DeleteStreamingSessionResponseTypeDef, GetStreamingSessionResponseTypeDef, ListStreamingSessionsResponseTypeDef, StartStreamingSessionResponseTypeDef, StopStreamingSessionResponseTypeDef, StreamConfigurationCreateTypeDef, StreamConfigurationTypeDef, CreateStreamingImageResponseTypeDef, DeleteStreamingImageResponseTypeDef, GetStreamingImageResponseTypeDef, ListStreamingImagesResponseTypeDef, UpdateStreamingImageResponseTypeDef, CreateStudioComponentRequestRequestTypeDef, StudioComponentTypeDef, UpdateStudioComponentRequestRequestTypeDef, GetLaunchProfileInitializationResponseTypeDef, CreateLaunchProfileRequestRequestTypeDef, UpdateLaunchProfileRequestRequestTypeDef, LaunchProfileTypeDef, CreateStudioComponentResponseTypeDef, DeleteStudioComponentResponseTypeDef, GetStudioComponentResponseTypeDef, ListStudioComponentsResponseTypeDef, UpdateStudioComponentResponseTypeDef, CreateLaunchProfileResponseTypeDef, DeleteLaunchProfileResponseTypeDef, GetLaunchProfileDetailsResponseTypeDef, GetLaunchProfileResponseTypeDef, ListLaunchProfilesResponseTypeDef, UpdateLaunchProfileResponseTypeDef, ) def get_structure() -> AcceptEulasRequestRequestTypeDef: return {...} ``` <a id="how-it-works"></a> ## 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. <a id="what's-new"></a> ## What's new <a id="implemented-features"></a> ### 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 <a id="latest-changes"></a> ### Latest changes Builder changelog can be found in [Releases](https://github.com/youtype/mypy_boto3_builder/releases). <a id="versioning"></a> ## Versioning `mypy-boto3-nimble` version is the same as related `boto3` version and follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. <a id="thank-you"></a> ## 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 <a id="documentation"></a> ## Documentation All services type annotations can be found in [boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_nimble/) <a id="support-and-contributing"></a> ## 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-nimble Summary: Type annotations for boto3.NimbleStudio 1.26.34 service generated with mypy-boto3-builder 7.12.0 Provides: python-mypy-boto3-nimble BuildRequires: python3-devel BuildRequires: python3-setuptools BuildRequires: python3-pip %description -n python3-mypy-boto3-nimble <a id="mypy-boto3-nimble"></a> # mypy-boto3-nimble [](https://pypi.org/project/mypy-boto3-nimble) [](https://pypi.org/project/mypy-boto3-nimble) [](https://mypy-boto3-builder.readthedocs.io/) [](https://pypistats.org/packages/mypy-boto3-nimble)  Type annotations for [boto3.NimbleStudio 1.26.34](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/nimble.html#NimbleStudio) 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.0](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-nimble docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_nimble/). See how it helps to find and fix potential bugs:  - [mypy-boto3-nimble](#mypy-boto3-nimble) - [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) <a id="how-to-install"></a> ## How to install <a id="vscode-extension"></a> ### 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 `NimbleStudio`. <a id="from-pypi-with-pip"></a> ### From PyPI with pip Install `boto3-stubs` for `NimbleStudio` service. ```bash # install with boto3 type annotations python -m pip install 'boto3-stubs[nimble]' # 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[nimble]' # standalone installation python -m pip install mypy-boto3-nimble ``` <a id="how-to-uninstall"></a> ## How to uninstall ```bash python -m pip uninstall -y mypy-boto3-nimble ``` <a id="usage"></a> ## Usage <a id="vscode"></a> ### 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[nimble]` in your environment: ```bash python -m pip install 'boto3-stubs[nimble]' ``` Both type checking and code completion should now work. No explicit type annotations required, write your `boto3` code as usual. <a id="pycharm"></a> ### PyCharm Install `boto3-stubs-lite[nimble]` in your environment: ```bash python -m pip install 'boto3-stubs-lite[nimble]'` ``` Both type checking and code completion should now work. Explicit type annotations **are required**. Use `boto3-stubs` package instead for implicit type discovery. <a id="emacs"></a> ### Emacs - Install `boto3-stubs` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[nimble]' ``` - 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. <a id="sublime-text"></a> ### Sublime Text - Install `boto3-stubs[nimble]` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[nimble]' ``` - 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. <a id="other-ides"></a> ### Other IDEs Not tested, but as long as your IDE supports `mypy` or `pyright`, everything should work. <a id="mypy"></a> ### mypy - Install `mypy`: `python -m pip install mypy` - Install `boto3-stubs[nimble]` in your environment: ```bash python -m pip install 'boto3-stubs[nimble]'` ``` Type checking should now work. No explicit type annotations required, write your `boto3` code as usual. <a id="pyright"></a> ### pyright - Install `pyright`: `npm i -g pyright` - Install `boto3-stubs[nimble]` in your environment: ```bash python -m pip install 'boto3-stubs[nimble]' ``` 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. <a id="explicit-type-annotations"></a> ## Explicit type annotations <a id="client-annotations"></a> ### Client annotations `NimbleStudioClient` provides annotations for `boto3.client("nimble")`. ```python from boto3.session import Session from mypy_boto3_nimble import NimbleStudioClient client: NimbleStudioClient = Session().client("nimble") # now client usage is checked by mypy and IDE should provide code completion ``` <a id="paginators-annotations"></a> ### Paginators annotations `mypy_boto3_nimble.paginator` module contains type annotations for all paginators. ```python from boto3.session import Session from mypy_boto3_nimble import NimbleStudioClient from mypy_boto3_nimble.paginator import ( ListEulaAcceptancesPaginator, ListEulasPaginator, ListLaunchProfileMembersPaginator, ListLaunchProfilesPaginator, ListStreamingImagesPaginator, ListStreamingSessionBackupsPaginator, ListStreamingSessionsPaginator, ListStudioComponentsPaginator, ListStudioMembersPaginator, ListStudiosPaginator, ) client: NimbleStudioClient = Session().client("nimble") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs list_eula_acceptances_paginator: ListEulaAcceptancesPaginator = client.get_paginator( "list_eula_acceptances" ) list_eulas_paginator: ListEulasPaginator = client.get_paginator("list_eulas") list_launch_profile_members_paginator: ListLaunchProfileMembersPaginator = client.get_paginator( "list_launch_profile_members" ) list_launch_profiles_paginator: ListLaunchProfilesPaginator = client.get_paginator( "list_launch_profiles" ) list_streaming_images_paginator: ListStreamingImagesPaginator = client.get_paginator( "list_streaming_images" ) list_streaming_session_backups_paginator: ListStreamingSessionBackupsPaginator = ( client.get_paginator("list_streaming_session_backups") ) list_streaming_sessions_paginator: ListStreamingSessionsPaginator = client.get_paginator( "list_streaming_sessions" ) list_studio_components_paginator: ListStudioComponentsPaginator = client.get_paginator( "list_studio_components" ) list_studio_members_paginator: ListStudioMembersPaginator = client.get_paginator( "list_studio_members" ) list_studios_paginator: ListStudiosPaginator = client.get_paginator("list_studios") ``` <a id="waiters-annotations"></a> ### Waiters annotations `mypy_boto3_nimble.waiter` module contains type annotations for all waiters. ```python from boto3.session import Session from mypy_boto3_nimble import NimbleStudioClient from mypy_boto3_nimble.waiter import ( LaunchProfileDeletedWaiter, LaunchProfileReadyWaiter, StreamingImageDeletedWaiter, StreamingImageReadyWaiter, StreamingSessionDeletedWaiter, StreamingSessionReadyWaiter, StreamingSessionStoppedWaiter, StreamingSessionStreamReadyWaiter, StudioComponentDeletedWaiter, StudioComponentReadyWaiter, StudioDeletedWaiter, StudioReadyWaiter, ) client: NimbleStudioClient = Session().client("nimble") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs launch_profile_deleted_waiter: LaunchProfileDeletedWaiter = client.get_waiter( "launch_profile_deleted" ) launch_profile_ready_waiter: LaunchProfileReadyWaiter = client.get_waiter("launch_profile_ready") streaming_image_deleted_waiter: StreamingImageDeletedWaiter = client.get_waiter( "streaming_image_deleted" ) streaming_image_ready_waiter: StreamingImageReadyWaiter = client.get_waiter("streaming_image_ready") streaming_session_deleted_waiter: StreamingSessionDeletedWaiter = client.get_waiter( "streaming_session_deleted" ) streaming_session_ready_waiter: StreamingSessionReadyWaiter = client.get_waiter( "streaming_session_ready" ) streaming_session_stopped_waiter: StreamingSessionStoppedWaiter = client.get_waiter( "streaming_session_stopped" ) streaming_session_stream_ready_waiter: StreamingSessionStreamReadyWaiter = client.get_waiter( "streaming_session_stream_ready" ) studio_component_deleted_waiter: StudioComponentDeletedWaiter = client.get_waiter( "studio_component_deleted" ) studio_component_ready_waiter: StudioComponentReadyWaiter = client.get_waiter( "studio_component_ready" ) studio_deleted_waiter: StudioDeletedWaiter = client.get_waiter("studio_deleted") studio_ready_waiter: StudioReadyWaiter = client.get_waiter("studio_ready") ``` <a id="literals"></a> ### Literals `mypy_boto3_nimble.literals` module contains literals extracted from shapes that can be used in user code for type checking. ```python from mypy_boto3_nimble.literals import ( AutomaticTerminationModeType, LaunchProfileDeletedWaiterName, LaunchProfilePersonaType, LaunchProfilePlatformType, LaunchProfileReadyWaiterName, LaunchProfileStateType, LaunchProfileStatusCodeType, LaunchProfileValidationStateType, LaunchProfileValidationStatusCodeType, LaunchProfileValidationTypeType, ListEulaAcceptancesPaginatorName, ListEulasPaginatorName, ListLaunchProfileMembersPaginatorName, ListLaunchProfilesPaginatorName, ListStreamingImagesPaginatorName, ListStreamingSessionBackupsPaginatorName, ListStreamingSessionsPaginatorName, ListStudioComponentsPaginatorName, ListStudioMembersPaginatorName, ListStudiosPaginatorName, SessionBackupModeType, SessionPersistenceModeType, StreamingClipboardModeType, StreamingImageDeletedWaiterName, StreamingImageEncryptionConfigurationKeyTypeType, StreamingImageReadyWaiterName, StreamingImageStateType, StreamingImageStatusCodeType, StreamingInstanceTypeType, StreamingSessionDeletedWaiterName, StreamingSessionReadyWaiterName, StreamingSessionStateType, StreamingSessionStatusCodeType, StreamingSessionStoppedWaiterName, StreamingSessionStorageModeType, StreamingSessionStreamReadyWaiterName, StreamingSessionStreamStateType, StreamingSessionStreamStatusCodeType, StudioComponentDeletedWaiterName, StudioComponentInitializationScriptRunContextType, StudioComponentReadyWaiterName, StudioComponentStateType, StudioComponentStatusCodeType, StudioComponentSubtypeType, StudioComponentTypeType, StudioDeletedWaiterName, StudioEncryptionConfigurationKeyTypeType, StudioPersonaType, StudioReadyWaiterName, StudioStateType, StudioStatusCodeType, VolumeRetentionModeType, NimbleStudioServiceName, ServiceName, ResourceServiceName, PaginatorName, WaiterName, RegionName, ) def check_value(value: AutomaticTerminationModeType) -> bool: ... ``` <a id="typed-dictionaries"></a> ### Typed dictionaries `mypy_boto3_nimble.type_defs` module contains structures and shapes assembled to typed dictionaries for additional type checking. ```python from mypy_boto3_nimble.type_defs import ( AcceptEulasRequestRequestTypeDef, EulaAcceptanceTypeDef, ResponseMetadataTypeDef, ActiveDirectoryComputerAttributeTypeDef, ComputeFarmConfigurationTypeDef, CreateStreamingImageRequestRequestTypeDef, CreateStreamingSessionRequestRequestTypeDef, CreateStreamingSessionStreamRequestRequestTypeDef, StreamingSessionStreamTypeDef, ScriptParameterKeyValueTypeDef, StudioComponentInitializationScriptTypeDef, StudioEncryptionConfigurationTypeDef, DeleteLaunchProfileMemberRequestRequestTypeDef, DeleteLaunchProfileRequestRequestTypeDef, DeleteStreamingImageRequestRequestTypeDef, DeleteStreamingSessionRequestRequestTypeDef, DeleteStudioComponentRequestRequestTypeDef, DeleteStudioMemberRequestRequestTypeDef, DeleteStudioRequestRequestTypeDef, EulaTypeDef, GetEulaRequestRequestTypeDef, GetLaunchProfileDetailsRequestRequestTypeDef, StudioComponentSummaryTypeDef, GetLaunchProfileInitializationRequestRequestTypeDef, GetLaunchProfileMemberRequestRequestTypeDef, LaunchProfileMembershipTypeDef, WaiterConfigTypeDef, GetLaunchProfileRequestRequestTypeDef, GetStreamingImageRequestRequestTypeDef, GetStreamingSessionBackupRequestRequestTypeDef, StreamingSessionBackupTypeDef, GetStreamingSessionRequestRequestTypeDef, GetStreamingSessionStreamRequestRequestTypeDef, GetStudioComponentRequestRequestTypeDef, GetStudioMemberRequestRequestTypeDef, StudioMembershipTypeDef, GetStudioRequestRequestTypeDef, LaunchProfileInitializationScriptTypeDef, ValidationResultTypeDef, LicenseServiceConfigurationTypeDef, PaginatorConfigTypeDef, ListEulaAcceptancesRequestRequestTypeDef, ListEulasRequestRequestTypeDef, ListLaunchProfileMembersRequestRequestTypeDef, ListLaunchProfilesRequestRequestTypeDef, ListStreamingImagesRequestRequestTypeDef, ListStreamingSessionBackupsRequestRequestTypeDef, ListStreamingSessionsRequestRequestTypeDef, ListStudioComponentsRequestRequestTypeDef, ListStudioMembersRequestRequestTypeDef, ListStudiosRequestRequestTypeDef, ListTagsForResourceRequestRequestTypeDef, NewLaunchProfileMemberTypeDef, NewStudioMemberTypeDef, SharedFileSystemConfigurationTypeDef, StartStreamingSessionRequestRequestTypeDef, StartStudioSSOConfigurationRepairRequestRequestTypeDef, StopStreamingSessionRequestRequestTypeDef, StreamConfigurationSessionBackupTypeDef, VolumeConfigurationTypeDef, StreamingSessionStorageRootTypeDef, StreamingImageEncryptionConfigurationTypeDef, TagResourceRequestRequestTypeDef, UntagResourceRequestRequestTypeDef, UpdateLaunchProfileMemberRequestRequestTypeDef, UpdateStreamingImageRequestRequestTypeDef, UpdateStudioRequestRequestTypeDef, AcceptEulasResponseTypeDef, ListEulaAcceptancesResponseTypeDef, ListTagsForResourceResponseTypeDef, ActiveDirectoryConfigurationTypeDef, LaunchProfileInitializationActiveDirectoryTypeDef, CreateStreamingSessionStreamResponseTypeDef, GetStreamingSessionStreamResponseTypeDef, CreateStudioRequestRequestTypeDef, StudioTypeDef, GetEulaResponseTypeDef, ListEulasResponseTypeDef, GetLaunchProfileMemberResponseTypeDef, ListLaunchProfileMembersResponseTypeDef, UpdateLaunchProfileMemberResponseTypeDef, GetLaunchProfileRequestLaunchProfileDeletedWaitTypeDef, GetLaunchProfileRequestLaunchProfileReadyWaitTypeDef, GetStreamingImageRequestStreamingImageDeletedWaitTypeDef, GetStreamingImageRequestStreamingImageReadyWaitTypeDef, GetStreamingSessionRequestStreamingSessionDeletedWaitTypeDef, GetStreamingSessionRequestStreamingSessionReadyWaitTypeDef, GetStreamingSessionRequestStreamingSessionStoppedWaitTypeDef, GetStreamingSessionStreamRequestStreamingSessionStreamReadyWaitTypeDef, GetStudioComponentRequestStudioComponentDeletedWaitTypeDef, GetStudioComponentRequestStudioComponentReadyWaitTypeDef, GetStudioRequestStudioDeletedWaitTypeDef, GetStudioRequestStudioReadyWaitTypeDef, GetStreamingSessionBackupResponseTypeDef, ListStreamingSessionBackupsResponseTypeDef, GetStudioMemberResponseTypeDef, ListStudioMembersResponseTypeDef, ListEulaAcceptancesRequestListEulaAcceptancesPaginateTypeDef, ListEulasRequestListEulasPaginateTypeDef, ListLaunchProfileMembersRequestListLaunchProfileMembersPaginateTypeDef, ListLaunchProfilesRequestListLaunchProfilesPaginateTypeDef, ListStreamingImagesRequestListStreamingImagesPaginateTypeDef, ListStreamingSessionBackupsRequestListStreamingSessionBackupsPaginateTypeDef, ListStreamingSessionsRequestListStreamingSessionsPaginateTypeDef, ListStudioComponentsRequestListStudioComponentsPaginateTypeDef, ListStudioMembersRequestListStudioMembersPaginateTypeDef, ListStudiosRequestListStudiosPaginateTypeDef, PutLaunchProfileMembersRequestRequestTypeDef, PutStudioMembersRequestRequestTypeDef, StreamingSessionTypeDef, StreamConfigurationSessionStorageTypeDef, StreamingImageTypeDef, StudioComponentConfigurationTypeDef, LaunchProfileInitializationTypeDef, CreateStudioResponseTypeDef, DeleteStudioResponseTypeDef, GetStudioResponseTypeDef, ListStudiosResponseTypeDef, StartStudioSSOConfigurationRepairResponseTypeDef, UpdateStudioResponseTypeDef, CreateStreamingSessionResponseTypeDef, DeleteStreamingSessionResponseTypeDef, GetStreamingSessionResponseTypeDef, ListStreamingSessionsResponseTypeDef, StartStreamingSessionResponseTypeDef, StopStreamingSessionResponseTypeDef, StreamConfigurationCreateTypeDef, StreamConfigurationTypeDef, CreateStreamingImageResponseTypeDef, DeleteStreamingImageResponseTypeDef, GetStreamingImageResponseTypeDef, ListStreamingImagesResponseTypeDef, UpdateStreamingImageResponseTypeDef, CreateStudioComponentRequestRequestTypeDef, StudioComponentTypeDef, UpdateStudioComponentRequestRequestTypeDef, GetLaunchProfileInitializationResponseTypeDef, CreateLaunchProfileRequestRequestTypeDef, UpdateLaunchProfileRequestRequestTypeDef, LaunchProfileTypeDef, CreateStudioComponentResponseTypeDef, DeleteStudioComponentResponseTypeDef, GetStudioComponentResponseTypeDef, ListStudioComponentsResponseTypeDef, UpdateStudioComponentResponseTypeDef, CreateLaunchProfileResponseTypeDef, DeleteLaunchProfileResponseTypeDef, GetLaunchProfileDetailsResponseTypeDef, GetLaunchProfileResponseTypeDef, ListLaunchProfilesResponseTypeDef, UpdateLaunchProfileResponseTypeDef, ) def get_structure() -> AcceptEulasRequestRequestTypeDef: return {...} ``` <a id="how-it-works"></a> ## 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. <a id="what's-new"></a> ## What's new <a id="implemented-features"></a> ### 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 <a id="latest-changes"></a> ### Latest changes Builder changelog can be found in [Releases](https://github.com/youtype/mypy_boto3_builder/releases). <a id="versioning"></a> ## Versioning `mypy-boto3-nimble` version is the same as related `boto3` version and follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. <a id="thank-you"></a> ## 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 <a id="documentation"></a> ## Documentation All services type annotations can be found in [boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_nimble/) <a id="support-and-contributing"></a> ## 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-nimble Provides: python3-mypy-boto3-nimble-doc %description help <a id="mypy-boto3-nimble"></a> # mypy-boto3-nimble [](https://pypi.org/project/mypy-boto3-nimble) [](https://pypi.org/project/mypy-boto3-nimble) [](https://mypy-boto3-builder.readthedocs.io/) [](https://pypistats.org/packages/mypy-boto3-nimble)  Type annotations for [boto3.NimbleStudio 1.26.34](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/nimble.html#NimbleStudio) 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.0](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-nimble docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_nimble/). See how it helps to find and fix potential bugs:  - [mypy-boto3-nimble](#mypy-boto3-nimble) - [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) <a id="how-to-install"></a> ## How to install <a id="vscode-extension"></a> ### 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 `NimbleStudio`. <a id="from-pypi-with-pip"></a> ### From PyPI with pip Install `boto3-stubs` for `NimbleStudio` service. ```bash # install with boto3 type annotations python -m pip install 'boto3-stubs[nimble]' # 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[nimble]' # standalone installation python -m pip install mypy-boto3-nimble ``` <a id="how-to-uninstall"></a> ## How to uninstall ```bash python -m pip uninstall -y mypy-boto3-nimble ``` <a id="usage"></a> ## Usage <a id="vscode"></a> ### 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[nimble]` in your environment: ```bash python -m pip install 'boto3-stubs[nimble]' ``` Both type checking and code completion should now work. No explicit type annotations required, write your `boto3` code as usual. <a id="pycharm"></a> ### PyCharm Install `boto3-stubs-lite[nimble]` in your environment: ```bash python -m pip install 'boto3-stubs-lite[nimble]'` ``` Both type checking and code completion should now work. Explicit type annotations **are required**. Use `boto3-stubs` package instead for implicit type discovery. <a id="emacs"></a> ### Emacs - Install `boto3-stubs` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[nimble]' ``` - 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. <a id="sublime-text"></a> ### Sublime Text - Install `boto3-stubs[nimble]` with services you use in your environment: ```bash python -m pip install 'boto3-stubs[nimble]' ``` - 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. <a id="other-ides"></a> ### Other IDEs Not tested, but as long as your IDE supports `mypy` or `pyright`, everything should work. <a id="mypy"></a> ### mypy - Install `mypy`: `python -m pip install mypy` - Install `boto3-stubs[nimble]` in your environment: ```bash python -m pip install 'boto3-stubs[nimble]'` ``` Type checking should now work. No explicit type annotations required, write your `boto3` code as usual. <a id="pyright"></a> ### pyright - Install `pyright`: `npm i -g pyright` - Install `boto3-stubs[nimble]` in your environment: ```bash python -m pip install 'boto3-stubs[nimble]' ``` 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. <a id="explicit-type-annotations"></a> ## Explicit type annotations <a id="client-annotations"></a> ### Client annotations `NimbleStudioClient` provides annotations for `boto3.client("nimble")`. ```python from boto3.session import Session from mypy_boto3_nimble import NimbleStudioClient client: NimbleStudioClient = Session().client("nimble") # now client usage is checked by mypy and IDE should provide code completion ``` <a id="paginators-annotations"></a> ### Paginators annotations `mypy_boto3_nimble.paginator` module contains type annotations for all paginators. ```python from boto3.session import Session from mypy_boto3_nimble import NimbleStudioClient from mypy_boto3_nimble.paginator import ( ListEulaAcceptancesPaginator, ListEulasPaginator, ListLaunchProfileMembersPaginator, ListLaunchProfilesPaginator, ListStreamingImagesPaginator, ListStreamingSessionBackupsPaginator, ListStreamingSessionsPaginator, ListStudioComponentsPaginator, ListStudioMembersPaginator, ListStudiosPaginator, ) client: NimbleStudioClient = Session().client("nimble") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs list_eula_acceptances_paginator: ListEulaAcceptancesPaginator = client.get_paginator( "list_eula_acceptances" ) list_eulas_paginator: ListEulasPaginator = client.get_paginator("list_eulas") list_launch_profile_members_paginator: ListLaunchProfileMembersPaginator = client.get_paginator( "list_launch_profile_members" ) list_launch_profiles_paginator: ListLaunchProfilesPaginator = client.get_paginator( "list_launch_profiles" ) list_streaming_images_paginator: ListStreamingImagesPaginator = client.get_paginator( "list_streaming_images" ) list_streaming_session_backups_paginator: ListStreamingSessionBackupsPaginator = ( client.get_paginator("list_streaming_session_backups") ) list_streaming_sessions_paginator: ListStreamingSessionsPaginator = client.get_paginator( "list_streaming_sessions" ) list_studio_components_paginator: ListStudioComponentsPaginator = client.get_paginator( "list_studio_components" ) list_studio_members_paginator: ListStudioMembersPaginator = client.get_paginator( "list_studio_members" ) list_studios_paginator: ListStudiosPaginator = client.get_paginator("list_studios") ``` <a id="waiters-annotations"></a> ### Waiters annotations `mypy_boto3_nimble.waiter` module contains type annotations for all waiters. ```python from boto3.session import Session from mypy_boto3_nimble import NimbleStudioClient from mypy_boto3_nimble.waiter import ( LaunchProfileDeletedWaiter, LaunchProfileReadyWaiter, StreamingImageDeletedWaiter, StreamingImageReadyWaiter, StreamingSessionDeletedWaiter, StreamingSessionReadyWaiter, StreamingSessionStoppedWaiter, StreamingSessionStreamReadyWaiter, StudioComponentDeletedWaiter, StudioComponentReadyWaiter, StudioDeletedWaiter, StudioReadyWaiter, ) client: NimbleStudioClient = Session().client("nimble") # Explicit type annotations are optional here # Types should be correctly discovered by mypy and IDEs launch_profile_deleted_waiter: LaunchProfileDeletedWaiter = client.get_waiter( "launch_profile_deleted" ) launch_profile_ready_waiter: LaunchProfileReadyWaiter = client.get_waiter("launch_profile_ready") streaming_image_deleted_waiter: StreamingImageDeletedWaiter = client.get_waiter( "streaming_image_deleted" ) streaming_image_ready_waiter: StreamingImageReadyWaiter = client.get_waiter("streaming_image_ready") streaming_session_deleted_waiter: StreamingSessionDeletedWaiter = client.get_waiter( "streaming_session_deleted" ) streaming_session_ready_waiter: StreamingSessionReadyWaiter = client.get_waiter( "streaming_session_ready" ) streaming_session_stopped_waiter: StreamingSessionStoppedWaiter = client.get_waiter( "streaming_session_stopped" ) streaming_session_stream_ready_waiter: StreamingSessionStreamReadyWaiter = client.get_waiter( "streaming_session_stream_ready" ) studio_component_deleted_waiter: StudioComponentDeletedWaiter = client.get_waiter( "studio_component_deleted" ) studio_component_ready_waiter: StudioComponentReadyWaiter = client.get_waiter( "studio_component_ready" ) studio_deleted_waiter: StudioDeletedWaiter = client.get_waiter("studio_deleted") studio_ready_waiter: StudioReadyWaiter = client.get_waiter("studio_ready") ``` <a id="literals"></a> ### Literals `mypy_boto3_nimble.literals` module contains literals extracted from shapes that can be used in user code for type checking. ```python from mypy_boto3_nimble.literals import ( AutomaticTerminationModeType, LaunchProfileDeletedWaiterName, LaunchProfilePersonaType, LaunchProfilePlatformType, LaunchProfileReadyWaiterName, LaunchProfileStateType, LaunchProfileStatusCodeType, LaunchProfileValidationStateType, LaunchProfileValidationStatusCodeType, LaunchProfileValidationTypeType, ListEulaAcceptancesPaginatorName, ListEulasPaginatorName, ListLaunchProfileMembersPaginatorName, ListLaunchProfilesPaginatorName, ListStreamingImagesPaginatorName, ListStreamingSessionBackupsPaginatorName, ListStreamingSessionsPaginatorName, ListStudioComponentsPaginatorName, ListStudioMembersPaginatorName, ListStudiosPaginatorName, SessionBackupModeType, SessionPersistenceModeType, StreamingClipboardModeType, StreamingImageDeletedWaiterName, StreamingImageEncryptionConfigurationKeyTypeType, StreamingImageReadyWaiterName, StreamingImageStateType, StreamingImageStatusCodeType, StreamingInstanceTypeType, StreamingSessionDeletedWaiterName, StreamingSessionReadyWaiterName, StreamingSessionStateType, StreamingSessionStatusCodeType, StreamingSessionStoppedWaiterName, StreamingSessionStorageModeType, StreamingSessionStreamReadyWaiterName, StreamingSessionStreamStateType, StreamingSessionStreamStatusCodeType, StudioComponentDeletedWaiterName, StudioComponentInitializationScriptRunContextType, StudioComponentReadyWaiterName, StudioComponentStateType, StudioComponentStatusCodeType, StudioComponentSubtypeType, StudioComponentTypeType, StudioDeletedWaiterName, StudioEncryptionConfigurationKeyTypeType, StudioPersonaType, StudioReadyWaiterName, StudioStateType, StudioStatusCodeType, VolumeRetentionModeType, NimbleStudioServiceName, ServiceName, ResourceServiceName, PaginatorName, WaiterName, RegionName, ) def check_value(value: AutomaticTerminationModeType) -> bool: ... ``` <a id="typed-dictionaries"></a> ### Typed dictionaries `mypy_boto3_nimble.type_defs` module contains structures and shapes assembled to typed dictionaries for additional type checking. ```python from mypy_boto3_nimble.type_defs import ( AcceptEulasRequestRequestTypeDef, EulaAcceptanceTypeDef, ResponseMetadataTypeDef, ActiveDirectoryComputerAttributeTypeDef, ComputeFarmConfigurationTypeDef, CreateStreamingImageRequestRequestTypeDef, CreateStreamingSessionRequestRequestTypeDef, CreateStreamingSessionStreamRequestRequestTypeDef, StreamingSessionStreamTypeDef, ScriptParameterKeyValueTypeDef, StudioComponentInitializationScriptTypeDef, StudioEncryptionConfigurationTypeDef, DeleteLaunchProfileMemberRequestRequestTypeDef, DeleteLaunchProfileRequestRequestTypeDef, DeleteStreamingImageRequestRequestTypeDef, DeleteStreamingSessionRequestRequestTypeDef, DeleteStudioComponentRequestRequestTypeDef, DeleteStudioMemberRequestRequestTypeDef, DeleteStudioRequestRequestTypeDef, EulaTypeDef, GetEulaRequestRequestTypeDef, GetLaunchProfileDetailsRequestRequestTypeDef, StudioComponentSummaryTypeDef, GetLaunchProfileInitializationRequestRequestTypeDef, GetLaunchProfileMemberRequestRequestTypeDef, LaunchProfileMembershipTypeDef, WaiterConfigTypeDef, GetLaunchProfileRequestRequestTypeDef, GetStreamingImageRequestRequestTypeDef, GetStreamingSessionBackupRequestRequestTypeDef, StreamingSessionBackupTypeDef, GetStreamingSessionRequestRequestTypeDef, GetStreamingSessionStreamRequestRequestTypeDef, GetStudioComponentRequestRequestTypeDef, GetStudioMemberRequestRequestTypeDef, StudioMembershipTypeDef, GetStudioRequestRequestTypeDef, LaunchProfileInitializationScriptTypeDef, ValidationResultTypeDef, LicenseServiceConfigurationTypeDef, PaginatorConfigTypeDef, ListEulaAcceptancesRequestRequestTypeDef, ListEulasRequestRequestTypeDef, ListLaunchProfileMembersRequestRequestTypeDef, ListLaunchProfilesRequestRequestTypeDef, ListStreamingImagesRequestRequestTypeDef, ListStreamingSessionBackupsRequestRequestTypeDef, ListStreamingSessionsRequestRequestTypeDef, ListStudioComponentsRequestRequestTypeDef, ListStudioMembersRequestRequestTypeDef, ListStudiosRequestRequestTypeDef, ListTagsForResourceRequestRequestTypeDef, NewLaunchProfileMemberTypeDef, NewStudioMemberTypeDef, SharedFileSystemConfigurationTypeDef, StartStreamingSessionRequestRequestTypeDef, StartStudioSSOConfigurationRepairRequestRequestTypeDef, StopStreamingSessionRequestRequestTypeDef, StreamConfigurationSessionBackupTypeDef, VolumeConfigurationTypeDef, StreamingSessionStorageRootTypeDef, StreamingImageEncryptionConfigurationTypeDef, TagResourceRequestRequestTypeDef, UntagResourceRequestRequestTypeDef, UpdateLaunchProfileMemberRequestRequestTypeDef, UpdateStreamingImageRequestRequestTypeDef, UpdateStudioRequestRequestTypeDef, AcceptEulasResponseTypeDef, ListEulaAcceptancesResponseTypeDef, ListTagsForResourceResponseTypeDef, ActiveDirectoryConfigurationTypeDef, LaunchProfileInitializationActiveDirectoryTypeDef, CreateStreamingSessionStreamResponseTypeDef, GetStreamingSessionStreamResponseTypeDef, CreateStudioRequestRequestTypeDef, StudioTypeDef, GetEulaResponseTypeDef, ListEulasResponseTypeDef, GetLaunchProfileMemberResponseTypeDef, ListLaunchProfileMembersResponseTypeDef, UpdateLaunchProfileMemberResponseTypeDef, GetLaunchProfileRequestLaunchProfileDeletedWaitTypeDef, GetLaunchProfileRequestLaunchProfileReadyWaitTypeDef, GetStreamingImageRequestStreamingImageDeletedWaitTypeDef, GetStreamingImageRequestStreamingImageReadyWaitTypeDef, GetStreamingSessionRequestStreamingSessionDeletedWaitTypeDef, GetStreamingSessionRequestStreamingSessionReadyWaitTypeDef, GetStreamingSessionRequestStreamingSessionStoppedWaitTypeDef, GetStreamingSessionStreamRequestStreamingSessionStreamReadyWaitTypeDef, GetStudioComponentRequestStudioComponentDeletedWaitTypeDef, GetStudioComponentRequestStudioComponentReadyWaitTypeDef, GetStudioRequestStudioDeletedWaitTypeDef, GetStudioRequestStudioReadyWaitTypeDef, GetStreamingSessionBackupResponseTypeDef, ListStreamingSessionBackupsResponseTypeDef, GetStudioMemberResponseTypeDef, ListStudioMembersResponseTypeDef, ListEulaAcceptancesRequestListEulaAcceptancesPaginateTypeDef, ListEulasRequestListEulasPaginateTypeDef, ListLaunchProfileMembersRequestListLaunchProfileMembersPaginateTypeDef, ListLaunchProfilesRequestListLaunchProfilesPaginateTypeDef, ListStreamingImagesRequestListStreamingImagesPaginateTypeDef, ListStreamingSessionBackupsRequestListStreamingSessionBackupsPaginateTypeDef, ListStreamingSessionsRequestListStreamingSessionsPaginateTypeDef, ListStudioComponentsRequestListStudioComponentsPaginateTypeDef, ListStudioMembersRequestListStudioMembersPaginateTypeDef, ListStudiosRequestListStudiosPaginateTypeDef, PutLaunchProfileMembersRequestRequestTypeDef, PutStudioMembersRequestRequestTypeDef, StreamingSessionTypeDef, StreamConfigurationSessionStorageTypeDef, StreamingImageTypeDef, StudioComponentConfigurationTypeDef, LaunchProfileInitializationTypeDef, CreateStudioResponseTypeDef, DeleteStudioResponseTypeDef, GetStudioResponseTypeDef, ListStudiosResponseTypeDef, StartStudioSSOConfigurationRepairResponseTypeDef, UpdateStudioResponseTypeDef, CreateStreamingSessionResponseTypeDef, DeleteStreamingSessionResponseTypeDef, GetStreamingSessionResponseTypeDef, ListStreamingSessionsResponseTypeDef, StartStreamingSessionResponseTypeDef, StopStreamingSessionResponseTypeDef, StreamConfigurationCreateTypeDef, StreamConfigurationTypeDef, CreateStreamingImageResponseTypeDef, DeleteStreamingImageResponseTypeDef, GetStreamingImageResponseTypeDef, ListStreamingImagesResponseTypeDef, UpdateStreamingImageResponseTypeDef, CreateStudioComponentRequestRequestTypeDef, StudioComponentTypeDef, UpdateStudioComponentRequestRequestTypeDef, GetLaunchProfileInitializationResponseTypeDef, CreateLaunchProfileRequestRequestTypeDef, UpdateLaunchProfileRequestRequestTypeDef, LaunchProfileTypeDef, CreateStudioComponentResponseTypeDef, DeleteStudioComponentResponseTypeDef, GetStudioComponentResponseTypeDef, ListStudioComponentsResponseTypeDef, UpdateStudioComponentResponseTypeDef, CreateLaunchProfileResponseTypeDef, DeleteLaunchProfileResponseTypeDef, GetLaunchProfileDetailsResponseTypeDef, GetLaunchProfileResponseTypeDef, ListLaunchProfilesResponseTypeDef, UpdateLaunchProfileResponseTypeDef, ) def get_structure() -> AcceptEulasRequestRequestTypeDef: return {...} ``` <a id="how-it-works"></a> ## 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. <a id="what's-new"></a> ## What's new <a id="implemented-features"></a> ### 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 <a id="latest-changes"></a> ### Latest changes Builder changelog can be found in [Releases](https://github.com/youtype/mypy_boto3_builder/releases). <a id="versioning"></a> ## Versioning `mypy-boto3-nimble` version is the same as related `boto3` version and follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. <a id="thank-you"></a> ## 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 <a id="documentation"></a> ## Documentation All services type annotations can be found in [boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_nimble/) <a id="support-and-contributing"></a> ## 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-nimble-1.26.34 %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-nimble -f filelist.lst %dir %{python3_sitelib}/* %files help -f doclist.lst %{_docdir}/* %changelog * Tue Apr 25 2023 Python_Bot <Python_Bot@openeuler.org> - 1.26.34-1 - Package Spec generated