%global _empty_manifest_terminate_build 0
Name: python-mypy-boto3-proton
Version: 1.26.108
Release: 1
Summary: Type annotations for boto3.Proton 1.26.108 service generated with mypy-boto3-builder 7.14.5
License: MIT License
URL: https://github.com/youtype/mypy_boto3_builder
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/de/52/2f3c6a42939ccbe06d993dfcb4ca43eb8bf4bf9119943cbec19804b19511/mypy-boto3-proton-1.26.108.tar.gz
BuildArch: noarch
Requires: python3-typing-extensions
%description
# mypy-boto3-proton
[](https://pypi.org/project/mypy-boto3-proton)
[](https://pypi.org/project/mypy-boto3-proton)
[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_proton/)
[](https://pypistats.org/packages/mypy-boto3-proton)
Type annotations for
[boto3.Proton 1.26.108](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/proton.html#Proton)
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.14.5](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-proton docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_proton/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-proton](#mypy-boto3-proton)
- [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 `Proton`.
### From PyPI with pip
Install `boto3-stubs` for `Proton` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[proton]'
# 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[proton]'
# standalone installation
python -m pip install mypy-boto3-proton
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-proton
```
## 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[proton]` in your environment:
```bash
python -m pip install 'boto3-stubs[proton]'
```
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[proton]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[proton]'`
```
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[proton]'
```
- 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[proton]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[proton]'
```
- 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[proton]` in your environment:
```bash
python -m pip install 'boto3-stubs[proton]'`
```
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[proton]` in your environment:
```bash
python -m pip install 'boto3-stubs[proton]'
```
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
`ProtonClient` provides annotations for `boto3.client("proton")`.
```python
from boto3.session import Session
from mypy_boto3_proton import ProtonClient
client: ProtonClient = Session().client("proton")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_proton.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_proton import ProtonClient
from mypy_boto3_proton.paginator import (
ListComponentOutputsPaginator,
ListComponentProvisionedResourcesPaginator,
ListComponentsPaginator,
ListEnvironmentAccountConnectionsPaginator,
ListEnvironmentOutputsPaginator,
ListEnvironmentProvisionedResourcesPaginator,
ListEnvironmentTemplateVersionsPaginator,
ListEnvironmentTemplatesPaginator,
ListEnvironmentsPaginator,
ListRepositoriesPaginator,
ListRepositorySyncDefinitionsPaginator,
ListServiceInstanceOutputsPaginator,
ListServiceInstanceProvisionedResourcesPaginator,
ListServiceInstancesPaginator,
ListServicePipelineOutputsPaginator,
ListServicePipelineProvisionedResourcesPaginator,
ListServiceTemplateVersionsPaginator,
ListServiceTemplatesPaginator,
ListServicesPaginator,
ListTagsForResourcePaginator,
)
client: ProtonClient = Session().client("proton")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_component_outputs_paginator: ListComponentOutputsPaginator = client.get_paginator(
"list_component_outputs"
)
list_component_provisioned_resources_paginator: ListComponentProvisionedResourcesPaginator = (
client.get_paginator("list_component_provisioned_resources")
)
list_components_paginator: ListComponentsPaginator = client.get_paginator("list_components")
list_environment_account_connections_paginator: ListEnvironmentAccountConnectionsPaginator = (
client.get_paginator("list_environment_account_connections")
)
list_environment_outputs_paginator: ListEnvironmentOutputsPaginator = client.get_paginator(
"list_environment_outputs"
)
list_environment_provisioned_resources_paginator: ListEnvironmentProvisionedResourcesPaginator = (
client.get_paginator("list_environment_provisioned_resources")
)
list_environment_template_versions_paginator: ListEnvironmentTemplateVersionsPaginator = (
client.get_paginator("list_environment_template_versions")
)
list_environment_templates_paginator: ListEnvironmentTemplatesPaginator = client.get_paginator(
"list_environment_templates"
)
list_environments_paginator: ListEnvironmentsPaginator = client.get_paginator("list_environments")
list_repositories_paginator: ListRepositoriesPaginator = client.get_paginator("list_repositories")
list_repository_sync_definitions_paginator: ListRepositorySyncDefinitionsPaginator = (
client.get_paginator("list_repository_sync_definitions")
)
list_service_instance_outputs_paginator: ListServiceInstanceOutputsPaginator = client.get_paginator(
"list_service_instance_outputs"
)
list_service_instance_provisioned_resources_paginator: ListServiceInstanceProvisionedResourcesPaginator = client.get_paginator(
"list_service_instance_provisioned_resources"
)
list_service_instances_paginator: ListServiceInstancesPaginator = client.get_paginator(
"list_service_instances"
)
list_service_pipeline_outputs_paginator: ListServicePipelineOutputsPaginator = client.get_paginator(
"list_service_pipeline_outputs"
)
list_service_pipeline_provisioned_resources_paginator: ListServicePipelineProvisionedResourcesPaginator = client.get_paginator(
"list_service_pipeline_provisioned_resources"
)
list_service_template_versions_paginator: ListServiceTemplateVersionsPaginator = (
client.get_paginator("list_service_template_versions")
)
list_service_templates_paginator: ListServiceTemplatesPaginator = client.get_paginator(
"list_service_templates"
)
list_services_paginator: ListServicesPaginator = client.get_paginator("list_services")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
"list_tags_for_resource"
)
```
### Waiters annotations
`mypy_boto3_proton.waiter` module contains type annotations for all waiters.
```python
from boto3.session import Session
from mypy_boto3_proton import ProtonClient
from mypy_boto3_proton.waiter import (
ComponentDeletedWaiter,
ComponentDeployedWaiter,
EnvironmentDeployedWaiter,
EnvironmentTemplateVersionRegisteredWaiter,
ServiceCreatedWaiter,
ServiceDeletedWaiter,
ServiceInstanceDeployedWaiter,
ServicePipelineDeployedWaiter,
ServiceTemplateVersionRegisteredWaiter,
ServiceUpdatedWaiter,
)
client: ProtonClient = Session().client("proton")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
component_deleted_waiter: ComponentDeletedWaiter = client.get_waiter("component_deleted")
component_deployed_waiter: ComponentDeployedWaiter = client.get_waiter("component_deployed")
environment_deployed_waiter: EnvironmentDeployedWaiter = client.get_waiter("environment_deployed")
environment_template_version_registered_waiter: EnvironmentTemplateVersionRegisteredWaiter = (
client.get_waiter("environment_template_version_registered")
)
service_created_waiter: ServiceCreatedWaiter = client.get_waiter("service_created")
service_deleted_waiter: ServiceDeletedWaiter = client.get_waiter("service_deleted")
service_instance_deployed_waiter: ServiceInstanceDeployedWaiter = client.get_waiter(
"service_instance_deployed"
)
service_pipeline_deployed_waiter: ServicePipelineDeployedWaiter = client.get_waiter(
"service_pipeline_deployed"
)
service_template_version_registered_waiter: ServiceTemplateVersionRegisteredWaiter = (
client.get_waiter("service_template_version_registered")
)
service_updated_waiter: ServiceUpdatedWaiter = client.get_waiter("service_updated")
```
### Literals
`mypy_boto3_proton.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_proton.literals import (
BlockerStatusType,
BlockerTypeType,
ComponentDeletedWaiterName,
ComponentDeployedWaiterName,
ComponentDeploymentUpdateTypeType,
DeploymentStatusType,
DeploymentUpdateTypeType,
EnvironmentAccountConnectionRequesterAccountTypeType,
EnvironmentAccountConnectionStatusType,
EnvironmentDeployedWaiterName,
EnvironmentTemplateVersionRegisteredWaiterName,
ListComponentOutputsPaginatorName,
ListComponentProvisionedResourcesPaginatorName,
ListComponentsPaginatorName,
ListEnvironmentAccountConnectionsPaginatorName,
ListEnvironmentOutputsPaginatorName,
ListEnvironmentProvisionedResourcesPaginatorName,
ListEnvironmentTemplateVersionsPaginatorName,
ListEnvironmentTemplatesPaginatorName,
ListEnvironmentsPaginatorName,
ListRepositoriesPaginatorName,
ListRepositorySyncDefinitionsPaginatorName,
ListServiceInstanceOutputsPaginatorName,
ListServiceInstanceProvisionedResourcesPaginatorName,
ListServiceInstancesFilterByType,
ListServiceInstancesPaginatorName,
ListServiceInstancesSortByType,
ListServicePipelineOutputsPaginatorName,
ListServicePipelineProvisionedResourcesPaginatorName,
ListServiceTemplateVersionsPaginatorName,
ListServiceTemplatesPaginatorName,
ListServicesPaginatorName,
ListTagsForResourcePaginatorName,
ProvisionedResourceEngineType,
ProvisioningType,
RepositoryProviderType,
RepositorySyncStatusType,
ResourceDeploymentStatusType,
ResourceSyncStatusType,
ServiceCreatedWaiterName,
ServiceDeletedWaiterName,
ServiceInstanceDeployedWaiterName,
ServicePipelineDeployedWaiterName,
ServiceStatusType,
ServiceTemplateSupportedComponentSourceTypeType,
ServiceTemplateVersionRegisteredWaiterName,
ServiceUpdatedWaiterName,
SortOrderType,
SyncTypeType,
TemplateTypeType,
TemplateVersionStatusType,
ProtonServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: BlockerStatusType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_proton.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_proton.type_defs import (
AcceptEnvironmentAccountConnectionInputRequestTypeDef,
EnvironmentAccountConnectionTypeDef,
ResponseMetadataTypeDef,
RepositoryBranchTypeDef,
CancelComponentDeploymentInputRequestTypeDef,
ComponentTypeDef,
CancelEnvironmentDeploymentInputRequestTypeDef,
CancelServiceInstanceDeploymentInputRequestTypeDef,
ServiceInstanceTypeDef,
CancelServicePipelineDeploymentInputRequestTypeDef,
ServicePipelineTypeDef,
CompatibleEnvironmentTemplateInputTypeDef,
CompatibleEnvironmentTemplateTypeDef,
ComponentSummaryTypeDef,
ResourceCountsSummaryTypeDef,
TagTypeDef,
RepositoryBranchInputTypeDef,
EnvironmentTemplateTypeDef,
EnvironmentTemplateVersionTypeDef,
RepositoryTypeDef,
CreateServiceSyncConfigInputRequestTypeDef,
ServiceSyncConfigTypeDef,
ServiceTemplateTypeDef,
CreateTemplateSyncConfigInputRequestTypeDef,
TemplateSyncConfigTypeDef,
DeleteComponentInputRequestTypeDef,
DeleteEnvironmentAccountConnectionInputRequestTypeDef,
DeleteEnvironmentInputRequestTypeDef,
DeleteEnvironmentTemplateInputRequestTypeDef,
DeleteEnvironmentTemplateVersionInputRequestTypeDef,
DeleteRepositoryInputRequestTypeDef,
DeleteServiceInputRequestTypeDef,
DeleteServiceSyncConfigInputRequestTypeDef,
DeleteServiceTemplateInputRequestTypeDef,
DeleteServiceTemplateVersionInputRequestTypeDef,
DeleteTemplateSyncConfigInputRequestTypeDef,
EnvironmentAccountConnectionSummaryTypeDef,
EnvironmentSummaryTypeDef,
EnvironmentTemplateFilterTypeDef,
EnvironmentTemplateSummaryTypeDef,
EnvironmentTemplateVersionSummaryTypeDef,
WaiterConfigTypeDef,
GetComponentInputRequestTypeDef,
GetEnvironmentAccountConnectionInputRequestTypeDef,
GetEnvironmentInputRequestTypeDef,
GetEnvironmentTemplateInputRequestTypeDef,
GetEnvironmentTemplateVersionInputRequestTypeDef,
GetRepositoryInputRequestTypeDef,
GetRepositorySyncStatusInputRequestTypeDef,
GetServiceInputRequestTypeDef,
GetServiceInstanceInputRequestTypeDef,
GetServiceInstanceSyncStatusInputRequestTypeDef,
RevisionTypeDef,
GetServiceSyncBlockerSummaryInputRequestTypeDef,
GetServiceSyncConfigInputRequestTypeDef,
GetServiceTemplateInputRequestTypeDef,
GetServiceTemplateVersionInputRequestTypeDef,
GetTemplateSyncConfigInputRequestTypeDef,
GetTemplateSyncStatusInputRequestTypeDef,
PaginatorConfigTypeDef,
ListComponentOutputsInputRequestTypeDef,
OutputTypeDef,
ListComponentProvisionedResourcesInputRequestTypeDef,
ProvisionedResourceTypeDef,
ListComponentsInputRequestTypeDef,
ListEnvironmentAccountConnectionsInputRequestTypeDef,
ListEnvironmentOutputsInputRequestTypeDef,
ListEnvironmentProvisionedResourcesInputRequestTypeDef,
ListEnvironmentTemplateVersionsInputRequestTypeDef,
ListEnvironmentTemplatesInputRequestTypeDef,
ListRepositoriesInputRequestTypeDef,
RepositorySummaryTypeDef,
ListRepositorySyncDefinitionsInputRequestTypeDef,
RepositorySyncDefinitionTypeDef,
ListServiceInstanceOutputsInputRequestTypeDef,
ListServiceInstanceProvisionedResourcesInputRequestTypeDef,
ListServiceInstancesFilterTypeDef,
ServiceInstanceSummaryTypeDef,
ListServicePipelineOutputsInputRequestTypeDef,
ListServicePipelineProvisionedResourcesInputRequestTypeDef,
ListServiceTemplateVersionsInputRequestTypeDef,
ServiceTemplateVersionSummaryTypeDef,
ListServiceTemplatesInputRequestTypeDef,
ServiceTemplateSummaryTypeDef,
ListServicesInputRequestTypeDef,
ServiceSummaryTypeDef,
ListTagsForResourceInputRequestTypeDef,
RejectEnvironmentAccountConnectionInputRequestTypeDef,
RepositorySyncEventTypeDef,
ResourceSyncEventTypeDef,
S3ObjectSourceTypeDef,
SyncBlockerContextTypeDef,
UntagResourceInputRequestTypeDef,
UpdateComponentInputRequestTypeDef,
UpdateEnvironmentAccountConnectionInputRequestTypeDef,
UpdateEnvironmentTemplateInputRequestTypeDef,
UpdateEnvironmentTemplateVersionInputRequestTypeDef,
UpdateServiceInputRequestTypeDef,
UpdateServiceInstanceInputRequestTypeDef,
UpdateServicePipelineInputRequestTypeDef,
UpdateServiceSyncBlockerInputRequestTypeDef,
UpdateServiceSyncConfigInputRequestTypeDef,
UpdateServiceTemplateInputRequestTypeDef,
UpdateTemplateSyncConfigInputRequestTypeDef,
AcceptEnvironmentAccountConnectionOutputTypeDef,
CreateEnvironmentAccountConnectionOutputTypeDef,
DeleteEnvironmentAccountConnectionOutputTypeDef,
GetEnvironmentAccountConnectionOutputTypeDef,
RejectEnvironmentAccountConnectionOutputTypeDef,
UpdateEnvironmentAccountConnectionOutputTypeDef,
AccountSettingsTypeDef,
EnvironmentTypeDef,
CancelComponentDeploymentOutputTypeDef,
CreateComponentOutputTypeDef,
DeleteComponentOutputTypeDef,
GetComponentOutputTypeDef,
UpdateComponentOutputTypeDef,
CancelServiceInstanceDeploymentOutputTypeDef,
CreateServiceInstanceOutputTypeDef,
GetServiceInstanceOutputTypeDef,
UpdateServiceInstanceOutputTypeDef,
CancelServicePipelineDeploymentOutputTypeDef,
ServiceTypeDef,
UpdateServicePipelineOutputTypeDef,
UpdateServiceTemplateVersionInputRequestTypeDef,
ServiceTemplateVersionTypeDef,
ListComponentsOutputTypeDef,
CountsSummaryTypeDef,
CreateComponentInputRequestTypeDef,
CreateEnvironmentAccountConnectionInputRequestTypeDef,
CreateEnvironmentTemplateInputRequestTypeDef,
CreateRepositoryInputRequestTypeDef,
CreateServiceInputRequestTypeDef,
CreateServiceInstanceInputRequestTypeDef,
CreateServiceTemplateInputRequestTypeDef,
ListTagsForResourceOutputTypeDef,
TagResourceInputRequestTypeDef,
CreateEnvironmentInputRequestTypeDef,
UpdateAccountSettingsInputRequestTypeDef,
UpdateEnvironmentInputRequestTypeDef,
CreateEnvironmentTemplateOutputTypeDef,
DeleteEnvironmentTemplateOutputTypeDef,
GetEnvironmentTemplateOutputTypeDef,
UpdateEnvironmentTemplateOutputTypeDef,
CreateEnvironmentTemplateVersionOutputTypeDef,
DeleteEnvironmentTemplateVersionOutputTypeDef,
GetEnvironmentTemplateVersionOutputTypeDef,
UpdateEnvironmentTemplateVersionOutputTypeDef,
CreateRepositoryOutputTypeDef,
DeleteRepositoryOutputTypeDef,
GetRepositoryOutputTypeDef,
CreateServiceSyncConfigOutputTypeDef,
DeleteServiceSyncConfigOutputTypeDef,
GetServiceSyncConfigOutputTypeDef,
UpdateServiceSyncConfigOutputTypeDef,
CreateServiceTemplateOutputTypeDef,
DeleteServiceTemplateOutputTypeDef,
GetServiceTemplateOutputTypeDef,
UpdateServiceTemplateOutputTypeDef,
CreateTemplateSyncConfigOutputTypeDef,
DeleteTemplateSyncConfigOutputTypeDef,
GetTemplateSyncConfigOutputTypeDef,
UpdateTemplateSyncConfigOutputTypeDef,
ListEnvironmentAccountConnectionsOutputTypeDef,
ListEnvironmentsOutputTypeDef,
ListEnvironmentsInputRequestTypeDef,
ListEnvironmentTemplatesOutputTypeDef,
ListEnvironmentTemplateVersionsOutputTypeDef,
GetComponentInputComponentDeletedWaitTypeDef,
GetComponentInputComponentDeployedWaitTypeDef,
GetEnvironmentInputEnvironmentDeployedWaitTypeDef,
GetEnvironmentTemplateVersionInputEnvironmentTemplateVersionRegisteredWaitTypeDef,
GetServiceInputServiceCreatedWaitTypeDef,
GetServiceInputServiceDeletedWaitTypeDef,
GetServiceInputServicePipelineDeployedWaitTypeDef,
GetServiceInputServiceUpdatedWaitTypeDef,
GetServiceInstanceInputServiceInstanceDeployedWaitTypeDef,
GetServiceTemplateVersionInputServiceTemplateVersionRegisteredWaitTypeDef,
ListComponentOutputsInputListComponentOutputsPaginateTypeDef,
ListComponentProvisionedResourcesInputListComponentProvisionedResourcesPaginateTypeDef,
ListComponentsInputListComponentsPaginateTypeDef,
ListEnvironmentAccountConnectionsInputListEnvironmentAccountConnectionsPaginateTypeDef,
ListEnvironmentOutputsInputListEnvironmentOutputsPaginateTypeDef,
ListEnvironmentProvisionedResourcesInputListEnvironmentProvisionedResourcesPaginateTypeDef,
ListEnvironmentTemplateVersionsInputListEnvironmentTemplateVersionsPaginateTypeDef,
ListEnvironmentTemplatesInputListEnvironmentTemplatesPaginateTypeDef,
ListEnvironmentsInputListEnvironmentsPaginateTypeDef,
ListRepositoriesInputListRepositoriesPaginateTypeDef,
ListRepositorySyncDefinitionsInputListRepositorySyncDefinitionsPaginateTypeDef,
ListServiceInstanceOutputsInputListServiceInstanceOutputsPaginateTypeDef,
ListServiceInstanceProvisionedResourcesInputListServiceInstanceProvisionedResourcesPaginateTypeDef,
ListServicePipelineOutputsInputListServicePipelineOutputsPaginateTypeDef,
ListServicePipelineProvisionedResourcesInputListServicePipelineProvisionedResourcesPaginateTypeDef,
ListServiceTemplateVersionsInputListServiceTemplateVersionsPaginateTypeDef,
ListServiceTemplatesInputListServiceTemplatesPaginateTypeDef,
ListServicesInputListServicesPaginateTypeDef,
ListTagsForResourceInputListTagsForResourcePaginateTypeDef,
ListComponentOutputsOutputTypeDef,
ListEnvironmentOutputsOutputTypeDef,
ListServiceInstanceOutputsOutputTypeDef,
ListServicePipelineOutputsOutputTypeDef,
NotifyResourceDeploymentStatusChangeInputRequestTypeDef,
ListComponentProvisionedResourcesOutputTypeDef,
ListEnvironmentProvisionedResourcesOutputTypeDef,
ListServiceInstanceProvisionedResourcesOutputTypeDef,
ListServicePipelineProvisionedResourcesOutputTypeDef,
ListRepositoriesOutputTypeDef,
ListRepositorySyncDefinitionsOutputTypeDef,
ListServiceInstancesInputListServiceInstancesPaginateTypeDef,
ListServiceInstancesInputRequestTypeDef,
ListServiceInstancesOutputTypeDef,
ListServiceTemplateVersionsOutputTypeDef,
ListServiceTemplatesOutputTypeDef,
ListServicesOutputTypeDef,
RepositorySyncAttemptTypeDef,
ResourceSyncAttemptTypeDef,
TemplateVersionSourceInputTypeDef,
SyncBlockerTypeDef,
GetAccountSettingsOutputTypeDef,
UpdateAccountSettingsOutputTypeDef,
CancelEnvironmentDeploymentOutputTypeDef,
CreateEnvironmentOutputTypeDef,
DeleteEnvironmentOutputTypeDef,
GetEnvironmentOutputTypeDef,
UpdateEnvironmentOutputTypeDef,
CreateServiceOutputTypeDef,
DeleteServiceOutputTypeDef,
GetServiceOutputTypeDef,
UpdateServiceOutputTypeDef,
CreateServiceTemplateVersionOutputTypeDef,
DeleteServiceTemplateVersionOutputTypeDef,
GetServiceTemplateVersionOutputTypeDef,
UpdateServiceTemplateVersionOutputTypeDef,
GetResourcesSummaryOutputTypeDef,
GetRepositorySyncStatusOutputTypeDef,
GetServiceInstanceSyncStatusOutputTypeDef,
GetTemplateSyncStatusOutputTypeDef,
CreateEnvironmentTemplateVersionInputRequestTypeDef,
CreateServiceTemplateVersionInputRequestTypeDef,
ServiceSyncBlockerSummaryTypeDef,
UpdateServiceSyncBlockerOutputTypeDef,
GetServiceSyncBlockerSummaryOutputTypeDef,
)
def get_structure() -> AcceptEnvironmentAccountConnectionInputRequestTypeDef:
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 drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from `botocore` schemas.
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [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`, `aiobotocore` and `aioboto3`
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.resource` calls
- Auto discovery of types for `session.client` and `session.resource` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-proton` 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_proton/)
## 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-proton
Summary: Type annotations for boto3.Proton 1.26.108 service generated with mypy-boto3-builder 7.14.5
Provides: python-mypy-boto3-proton
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-mypy-boto3-proton
# mypy-boto3-proton
[](https://pypi.org/project/mypy-boto3-proton)
[](https://pypi.org/project/mypy-boto3-proton)
[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_proton/)
[](https://pypistats.org/packages/mypy-boto3-proton)
Type annotations for
[boto3.Proton 1.26.108](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/proton.html#Proton)
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.14.5](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-proton docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_proton/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-proton](#mypy-boto3-proton)
- [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 `Proton`.
### From PyPI with pip
Install `boto3-stubs` for `Proton` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[proton]'
# 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[proton]'
# standalone installation
python -m pip install mypy-boto3-proton
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-proton
```
## 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[proton]` in your environment:
```bash
python -m pip install 'boto3-stubs[proton]'
```
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[proton]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[proton]'`
```
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[proton]'
```
- 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[proton]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[proton]'
```
- 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[proton]` in your environment:
```bash
python -m pip install 'boto3-stubs[proton]'`
```
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[proton]` in your environment:
```bash
python -m pip install 'boto3-stubs[proton]'
```
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
`ProtonClient` provides annotations for `boto3.client("proton")`.
```python
from boto3.session import Session
from mypy_boto3_proton import ProtonClient
client: ProtonClient = Session().client("proton")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_proton.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_proton import ProtonClient
from mypy_boto3_proton.paginator import (
ListComponentOutputsPaginator,
ListComponentProvisionedResourcesPaginator,
ListComponentsPaginator,
ListEnvironmentAccountConnectionsPaginator,
ListEnvironmentOutputsPaginator,
ListEnvironmentProvisionedResourcesPaginator,
ListEnvironmentTemplateVersionsPaginator,
ListEnvironmentTemplatesPaginator,
ListEnvironmentsPaginator,
ListRepositoriesPaginator,
ListRepositorySyncDefinitionsPaginator,
ListServiceInstanceOutputsPaginator,
ListServiceInstanceProvisionedResourcesPaginator,
ListServiceInstancesPaginator,
ListServicePipelineOutputsPaginator,
ListServicePipelineProvisionedResourcesPaginator,
ListServiceTemplateVersionsPaginator,
ListServiceTemplatesPaginator,
ListServicesPaginator,
ListTagsForResourcePaginator,
)
client: ProtonClient = Session().client("proton")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_component_outputs_paginator: ListComponentOutputsPaginator = client.get_paginator(
"list_component_outputs"
)
list_component_provisioned_resources_paginator: ListComponentProvisionedResourcesPaginator = (
client.get_paginator("list_component_provisioned_resources")
)
list_components_paginator: ListComponentsPaginator = client.get_paginator("list_components")
list_environment_account_connections_paginator: ListEnvironmentAccountConnectionsPaginator = (
client.get_paginator("list_environment_account_connections")
)
list_environment_outputs_paginator: ListEnvironmentOutputsPaginator = client.get_paginator(
"list_environment_outputs"
)
list_environment_provisioned_resources_paginator: ListEnvironmentProvisionedResourcesPaginator = (
client.get_paginator("list_environment_provisioned_resources")
)
list_environment_template_versions_paginator: ListEnvironmentTemplateVersionsPaginator = (
client.get_paginator("list_environment_template_versions")
)
list_environment_templates_paginator: ListEnvironmentTemplatesPaginator = client.get_paginator(
"list_environment_templates"
)
list_environments_paginator: ListEnvironmentsPaginator = client.get_paginator("list_environments")
list_repositories_paginator: ListRepositoriesPaginator = client.get_paginator("list_repositories")
list_repository_sync_definitions_paginator: ListRepositorySyncDefinitionsPaginator = (
client.get_paginator("list_repository_sync_definitions")
)
list_service_instance_outputs_paginator: ListServiceInstanceOutputsPaginator = client.get_paginator(
"list_service_instance_outputs"
)
list_service_instance_provisioned_resources_paginator: ListServiceInstanceProvisionedResourcesPaginator = client.get_paginator(
"list_service_instance_provisioned_resources"
)
list_service_instances_paginator: ListServiceInstancesPaginator = client.get_paginator(
"list_service_instances"
)
list_service_pipeline_outputs_paginator: ListServicePipelineOutputsPaginator = client.get_paginator(
"list_service_pipeline_outputs"
)
list_service_pipeline_provisioned_resources_paginator: ListServicePipelineProvisionedResourcesPaginator = client.get_paginator(
"list_service_pipeline_provisioned_resources"
)
list_service_template_versions_paginator: ListServiceTemplateVersionsPaginator = (
client.get_paginator("list_service_template_versions")
)
list_service_templates_paginator: ListServiceTemplatesPaginator = client.get_paginator(
"list_service_templates"
)
list_services_paginator: ListServicesPaginator = client.get_paginator("list_services")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
"list_tags_for_resource"
)
```
### Waiters annotations
`mypy_boto3_proton.waiter` module contains type annotations for all waiters.
```python
from boto3.session import Session
from mypy_boto3_proton import ProtonClient
from mypy_boto3_proton.waiter import (
ComponentDeletedWaiter,
ComponentDeployedWaiter,
EnvironmentDeployedWaiter,
EnvironmentTemplateVersionRegisteredWaiter,
ServiceCreatedWaiter,
ServiceDeletedWaiter,
ServiceInstanceDeployedWaiter,
ServicePipelineDeployedWaiter,
ServiceTemplateVersionRegisteredWaiter,
ServiceUpdatedWaiter,
)
client: ProtonClient = Session().client("proton")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
component_deleted_waiter: ComponentDeletedWaiter = client.get_waiter("component_deleted")
component_deployed_waiter: ComponentDeployedWaiter = client.get_waiter("component_deployed")
environment_deployed_waiter: EnvironmentDeployedWaiter = client.get_waiter("environment_deployed")
environment_template_version_registered_waiter: EnvironmentTemplateVersionRegisteredWaiter = (
client.get_waiter("environment_template_version_registered")
)
service_created_waiter: ServiceCreatedWaiter = client.get_waiter("service_created")
service_deleted_waiter: ServiceDeletedWaiter = client.get_waiter("service_deleted")
service_instance_deployed_waiter: ServiceInstanceDeployedWaiter = client.get_waiter(
"service_instance_deployed"
)
service_pipeline_deployed_waiter: ServicePipelineDeployedWaiter = client.get_waiter(
"service_pipeline_deployed"
)
service_template_version_registered_waiter: ServiceTemplateVersionRegisteredWaiter = (
client.get_waiter("service_template_version_registered")
)
service_updated_waiter: ServiceUpdatedWaiter = client.get_waiter("service_updated")
```
### Literals
`mypy_boto3_proton.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_proton.literals import (
BlockerStatusType,
BlockerTypeType,
ComponentDeletedWaiterName,
ComponentDeployedWaiterName,
ComponentDeploymentUpdateTypeType,
DeploymentStatusType,
DeploymentUpdateTypeType,
EnvironmentAccountConnectionRequesterAccountTypeType,
EnvironmentAccountConnectionStatusType,
EnvironmentDeployedWaiterName,
EnvironmentTemplateVersionRegisteredWaiterName,
ListComponentOutputsPaginatorName,
ListComponentProvisionedResourcesPaginatorName,
ListComponentsPaginatorName,
ListEnvironmentAccountConnectionsPaginatorName,
ListEnvironmentOutputsPaginatorName,
ListEnvironmentProvisionedResourcesPaginatorName,
ListEnvironmentTemplateVersionsPaginatorName,
ListEnvironmentTemplatesPaginatorName,
ListEnvironmentsPaginatorName,
ListRepositoriesPaginatorName,
ListRepositorySyncDefinitionsPaginatorName,
ListServiceInstanceOutputsPaginatorName,
ListServiceInstanceProvisionedResourcesPaginatorName,
ListServiceInstancesFilterByType,
ListServiceInstancesPaginatorName,
ListServiceInstancesSortByType,
ListServicePipelineOutputsPaginatorName,
ListServicePipelineProvisionedResourcesPaginatorName,
ListServiceTemplateVersionsPaginatorName,
ListServiceTemplatesPaginatorName,
ListServicesPaginatorName,
ListTagsForResourcePaginatorName,
ProvisionedResourceEngineType,
ProvisioningType,
RepositoryProviderType,
RepositorySyncStatusType,
ResourceDeploymentStatusType,
ResourceSyncStatusType,
ServiceCreatedWaiterName,
ServiceDeletedWaiterName,
ServiceInstanceDeployedWaiterName,
ServicePipelineDeployedWaiterName,
ServiceStatusType,
ServiceTemplateSupportedComponentSourceTypeType,
ServiceTemplateVersionRegisteredWaiterName,
ServiceUpdatedWaiterName,
SortOrderType,
SyncTypeType,
TemplateTypeType,
TemplateVersionStatusType,
ProtonServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: BlockerStatusType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_proton.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_proton.type_defs import (
AcceptEnvironmentAccountConnectionInputRequestTypeDef,
EnvironmentAccountConnectionTypeDef,
ResponseMetadataTypeDef,
RepositoryBranchTypeDef,
CancelComponentDeploymentInputRequestTypeDef,
ComponentTypeDef,
CancelEnvironmentDeploymentInputRequestTypeDef,
CancelServiceInstanceDeploymentInputRequestTypeDef,
ServiceInstanceTypeDef,
CancelServicePipelineDeploymentInputRequestTypeDef,
ServicePipelineTypeDef,
CompatibleEnvironmentTemplateInputTypeDef,
CompatibleEnvironmentTemplateTypeDef,
ComponentSummaryTypeDef,
ResourceCountsSummaryTypeDef,
TagTypeDef,
RepositoryBranchInputTypeDef,
EnvironmentTemplateTypeDef,
EnvironmentTemplateVersionTypeDef,
RepositoryTypeDef,
CreateServiceSyncConfigInputRequestTypeDef,
ServiceSyncConfigTypeDef,
ServiceTemplateTypeDef,
CreateTemplateSyncConfigInputRequestTypeDef,
TemplateSyncConfigTypeDef,
DeleteComponentInputRequestTypeDef,
DeleteEnvironmentAccountConnectionInputRequestTypeDef,
DeleteEnvironmentInputRequestTypeDef,
DeleteEnvironmentTemplateInputRequestTypeDef,
DeleteEnvironmentTemplateVersionInputRequestTypeDef,
DeleteRepositoryInputRequestTypeDef,
DeleteServiceInputRequestTypeDef,
DeleteServiceSyncConfigInputRequestTypeDef,
DeleteServiceTemplateInputRequestTypeDef,
DeleteServiceTemplateVersionInputRequestTypeDef,
DeleteTemplateSyncConfigInputRequestTypeDef,
EnvironmentAccountConnectionSummaryTypeDef,
EnvironmentSummaryTypeDef,
EnvironmentTemplateFilterTypeDef,
EnvironmentTemplateSummaryTypeDef,
EnvironmentTemplateVersionSummaryTypeDef,
WaiterConfigTypeDef,
GetComponentInputRequestTypeDef,
GetEnvironmentAccountConnectionInputRequestTypeDef,
GetEnvironmentInputRequestTypeDef,
GetEnvironmentTemplateInputRequestTypeDef,
GetEnvironmentTemplateVersionInputRequestTypeDef,
GetRepositoryInputRequestTypeDef,
GetRepositorySyncStatusInputRequestTypeDef,
GetServiceInputRequestTypeDef,
GetServiceInstanceInputRequestTypeDef,
GetServiceInstanceSyncStatusInputRequestTypeDef,
RevisionTypeDef,
GetServiceSyncBlockerSummaryInputRequestTypeDef,
GetServiceSyncConfigInputRequestTypeDef,
GetServiceTemplateInputRequestTypeDef,
GetServiceTemplateVersionInputRequestTypeDef,
GetTemplateSyncConfigInputRequestTypeDef,
GetTemplateSyncStatusInputRequestTypeDef,
PaginatorConfigTypeDef,
ListComponentOutputsInputRequestTypeDef,
OutputTypeDef,
ListComponentProvisionedResourcesInputRequestTypeDef,
ProvisionedResourceTypeDef,
ListComponentsInputRequestTypeDef,
ListEnvironmentAccountConnectionsInputRequestTypeDef,
ListEnvironmentOutputsInputRequestTypeDef,
ListEnvironmentProvisionedResourcesInputRequestTypeDef,
ListEnvironmentTemplateVersionsInputRequestTypeDef,
ListEnvironmentTemplatesInputRequestTypeDef,
ListRepositoriesInputRequestTypeDef,
RepositorySummaryTypeDef,
ListRepositorySyncDefinitionsInputRequestTypeDef,
RepositorySyncDefinitionTypeDef,
ListServiceInstanceOutputsInputRequestTypeDef,
ListServiceInstanceProvisionedResourcesInputRequestTypeDef,
ListServiceInstancesFilterTypeDef,
ServiceInstanceSummaryTypeDef,
ListServicePipelineOutputsInputRequestTypeDef,
ListServicePipelineProvisionedResourcesInputRequestTypeDef,
ListServiceTemplateVersionsInputRequestTypeDef,
ServiceTemplateVersionSummaryTypeDef,
ListServiceTemplatesInputRequestTypeDef,
ServiceTemplateSummaryTypeDef,
ListServicesInputRequestTypeDef,
ServiceSummaryTypeDef,
ListTagsForResourceInputRequestTypeDef,
RejectEnvironmentAccountConnectionInputRequestTypeDef,
RepositorySyncEventTypeDef,
ResourceSyncEventTypeDef,
S3ObjectSourceTypeDef,
SyncBlockerContextTypeDef,
UntagResourceInputRequestTypeDef,
UpdateComponentInputRequestTypeDef,
UpdateEnvironmentAccountConnectionInputRequestTypeDef,
UpdateEnvironmentTemplateInputRequestTypeDef,
UpdateEnvironmentTemplateVersionInputRequestTypeDef,
UpdateServiceInputRequestTypeDef,
UpdateServiceInstanceInputRequestTypeDef,
UpdateServicePipelineInputRequestTypeDef,
UpdateServiceSyncBlockerInputRequestTypeDef,
UpdateServiceSyncConfigInputRequestTypeDef,
UpdateServiceTemplateInputRequestTypeDef,
UpdateTemplateSyncConfigInputRequestTypeDef,
AcceptEnvironmentAccountConnectionOutputTypeDef,
CreateEnvironmentAccountConnectionOutputTypeDef,
DeleteEnvironmentAccountConnectionOutputTypeDef,
GetEnvironmentAccountConnectionOutputTypeDef,
RejectEnvironmentAccountConnectionOutputTypeDef,
UpdateEnvironmentAccountConnectionOutputTypeDef,
AccountSettingsTypeDef,
EnvironmentTypeDef,
CancelComponentDeploymentOutputTypeDef,
CreateComponentOutputTypeDef,
DeleteComponentOutputTypeDef,
GetComponentOutputTypeDef,
UpdateComponentOutputTypeDef,
CancelServiceInstanceDeploymentOutputTypeDef,
CreateServiceInstanceOutputTypeDef,
GetServiceInstanceOutputTypeDef,
UpdateServiceInstanceOutputTypeDef,
CancelServicePipelineDeploymentOutputTypeDef,
ServiceTypeDef,
UpdateServicePipelineOutputTypeDef,
UpdateServiceTemplateVersionInputRequestTypeDef,
ServiceTemplateVersionTypeDef,
ListComponentsOutputTypeDef,
CountsSummaryTypeDef,
CreateComponentInputRequestTypeDef,
CreateEnvironmentAccountConnectionInputRequestTypeDef,
CreateEnvironmentTemplateInputRequestTypeDef,
CreateRepositoryInputRequestTypeDef,
CreateServiceInputRequestTypeDef,
CreateServiceInstanceInputRequestTypeDef,
CreateServiceTemplateInputRequestTypeDef,
ListTagsForResourceOutputTypeDef,
TagResourceInputRequestTypeDef,
CreateEnvironmentInputRequestTypeDef,
UpdateAccountSettingsInputRequestTypeDef,
UpdateEnvironmentInputRequestTypeDef,
CreateEnvironmentTemplateOutputTypeDef,
DeleteEnvironmentTemplateOutputTypeDef,
GetEnvironmentTemplateOutputTypeDef,
UpdateEnvironmentTemplateOutputTypeDef,
CreateEnvironmentTemplateVersionOutputTypeDef,
DeleteEnvironmentTemplateVersionOutputTypeDef,
GetEnvironmentTemplateVersionOutputTypeDef,
UpdateEnvironmentTemplateVersionOutputTypeDef,
CreateRepositoryOutputTypeDef,
DeleteRepositoryOutputTypeDef,
GetRepositoryOutputTypeDef,
CreateServiceSyncConfigOutputTypeDef,
DeleteServiceSyncConfigOutputTypeDef,
GetServiceSyncConfigOutputTypeDef,
UpdateServiceSyncConfigOutputTypeDef,
CreateServiceTemplateOutputTypeDef,
DeleteServiceTemplateOutputTypeDef,
GetServiceTemplateOutputTypeDef,
UpdateServiceTemplateOutputTypeDef,
CreateTemplateSyncConfigOutputTypeDef,
DeleteTemplateSyncConfigOutputTypeDef,
GetTemplateSyncConfigOutputTypeDef,
UpdateTemplateSyncConfigOutputTypeDef,
ListEnvironmentAccountConnectionsOutputTypeDef,
ListEnvironmentsOutputTypeDef,
ListEnvironmentsInputRequestTypeDef,
ListEnvironmentTemplatesOutputTypeDef,
ListEnvironmentTemplateVersionsOutputTypeDef,
GetComponentInputComponentDeletedWaitTypeDef,
GetComponentInputComponentDeployedWaitTypeDef,
GetEnvironmentInputEnvironmentDeployedWaitTypeDef,
GetEnvironmentTemplateVersionInputEnvironmentTemplateVersionRegisteredWaitTypeDef,
GetServiceInputServiceCreatedWaitTypeDef,
GetServiceInputServiceDeletedWaitTypeDef,
GetServiceInputServicePipelineDeployedWaitTypeDef,
GetServiceInputServiceUpdatedWaitTypeDef,
GetServiceInstanceInputServiceInstanceDeployedWaitTypeDef,
GetServiceTemplateVersionInputServiceTemplateVersionRegisteredWaitTypeDef,
ListComponentOutputsInputListComponentOutputsPaginateTypeDef,
ListComponentProvisionedResourcesInputListComponentProvisionedResourcesPaginateTypeDef,
ListComponentsInputListComponentsPaginateTypeDef,
ListEnvironmentAccountConnectionsInputListEnvironmentAccountConnectionsPaginateTypeDef,
ListEnvironmentOutputsInputListEnvironmentOutputsPaginateTypeDef,
ListEnvironmentProvisionedResourcesInputListEnvironmentProvisionedResourcesPaginateTypeDef,
ListEnvironmentTemplateVersionsInputListEnvironmentTemplateVersionsPaginateTypeDef,
ListEnvironmentTemplatesInputListEnvironmentTemplatesPaginateTypeDef,
ListEnvironmentsInputListEnvironmentsPaginateTypeDef,
ListRepositoriesInputListRepositoriesPaginateTypeDef,
ListRepositorySyncDefinitionsInputListRepositorySyncDefinitionsPaginateTypeDef,
ListServiceInstanceOutputsInputListServiceInstanceOutputsPaginateTypeDef,
ListServiceInstanceProvisionedResourcesInputListServiceInstanceProvisionedResourcesPaginateTypeDef,
ListServicePipelineOutputsInputListServicePipelineOutputsPaginateTypeDef,
ListServicePipelineProvisionedResourcesInputListServicePipelineProvisionedResourcesPaginateTypeDef,
ListServiceTemplateVersionsInputListServiceTemplateVersionsPaginateTypeDef,
ListServiceTemplatesInputListServiceTemplatesPaginateTypeDef,
ListServicesInputListServicesPaginateTypeDef,
ListTagsForResourceInputListTagsForResourcePaginateTypeDef,
ListComponentOutputsOutputTypeDef,
ListEnvironmentOutputsOutputTypeDef,
ListServiceInstanceOutputsOutputTypeDef,
ListServicePipelineOutputsOutputTypeDef,
NotifyResourceDeploymentStatusChangeInputRequestTypeDef,
ListComponentProvisionedResourcesOutputTypeDef,
ListEnvironmentProvisionedResourcesOutputTypeDef,
ListServiceInstanceProvisionedResourcesOutputTypeDef,
ListServicePipelineProvisionedResourcesOutputTypeDef,
ListRepositoriesOutputTypeDef,
ListRepositorySyncDefinitionsOutputTypeDef,
ListServiceInstancesInputListServiceInstancesPaginateTypeDef,
ListServiceInstancesInputRequestTypeDef,
ListServiceInstancesOutputTypeDef,
ListServiceTemplateVersionsOutputTypeDef,
ListServiceTemplatesOutputTypeDef,
ListServicesOutputTypeDef,
RepositorySyncAttemptTypeDef,
ResourceSyncAttemptTypeDef,
TemplateVersionSourceInputTypeDef,
SyncBlockerTypeDef,
GetAccountSettingsOutputTypeDef,
UpdateAccountSettingsOutputTypeDef,
CancelEnvironmentDeploymentOutputTypeDef,
CreateEnvironmentOutputTypeDef,
DeleteEnvironmentOutputTypeDef,
GetEnvironmentOutputTypeDef,
UpdateEnvironmentOutputTypeDef,
CreateServiceOutputTypeDef,
DeleteServiceOutputTypeDef,
GetServiceOutputTypeDef,
UpdateServiceOutputTypeDef,
CreateServiceTemplateVersionOutputTypeDef,
DeleteServiceTemplateVersionOutputTypeDef,
GetServiceTemplateVersionOutputTypeDef,
UpdateServiceTemplateVersionOutputTypeDef,
GetResourcesSummaryOutputTypeDef,
GetRepositorySyncStatusOutputTypeDef,
GetServiceInstanceSyncStatusOutputTypeDef,
GetTemplateSyncStatusOutputTypeDef,
CreateEnvironmentTemplateVersionInputRequestTypeDef,
CreateServiceTemplateVersionInputRequestTypeDef,
ServiceSyncBlockerSummaryTypeDef,
UpdateServiceSyncBlockerOutputTypeDef,
GetServiceSyncBlockerSummaryOutputTypeDef,
)
def get_structure() -> AcceptEnvironmentAccountConnectionInputRequestTypeDef:
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 drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from `botocore` schemas.
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [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`, `aiobotocore` and `aioboto3`
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.resource` calls
- Auto discovery of types for `session.client` and `session.resource` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-proton` 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_proton/)
## 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-proton
Provides: python3-mypy-boto3-proton-doc
%description help
# mypy-boto3-proton
[](https://pypi.org/project/mypy-boto3-proton)
[](https://pypi.org/project/mypy-boto3-proton)
[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_proton/)
[](https://pypistats.org/packages/mypy-boto3-proton)
Type annotations for
[boto3.Proton 1.26.108](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/proton.html#Proton)
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.14.5](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-proton docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_proton/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-proton](#mypy-boto3-proton)
- [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 `Proton`.
### From PyPI with pip
Install `boto3-stubs` for `Proton` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[proton]'
# 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[proton]'
# standalone installation
python -m pip install mypy-boto3-proton
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-proton
```
## 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[proton]` in your environment:
```bash
python -m pip install 'boto3-stubs[proton]'
```
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[proton]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[proton]'`
```
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[proton]'
```
- 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[proton]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[proton]'
```
- 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[proton]` in your environment:
```bash
python -m pip install 'boto3-stubs[proton]'`
```
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[proton]` in your environment:
```bash
python -m pip install 'boto3-stubs[proton]'
```
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
`ProtonClient` provides annotations for `boto3.client("proton")`.
```python
from boto3.session import Session
from mypy_boto3_proton import ProtonClient
client: ProtonClient = Session().client("proton")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_proton.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_proton import ProtonClient
from mypy_boto3_proton.paginator import (
ListComponentOutputsPaginator,
ListComponentProvisionedResourcesPaginator,
ListComponentsPaginator,
ListEnvironmentAccountConnectionsPaginator,
ListEnvironmentOutputsPaginator,
ListEnvironmentProvisionedResourcesPaginator,
ListEnvironmentTemplateVersionsPaginator,
ListEnvironmentTemplatesPaginator,
ListEnvironmentsPaginator,
ListRepositoriesPaginator,
ListRepositorySyncDefinitionsPaginator,
ListServiceInstanceOutputsPaginator,
ListServiceInstanceProvisionedResourcesPaginator,
ListServiceInstancesPaginator,
ListServicePipelineOutputsPaginator,
ListServicePipelineProvisionedResourcesPaginator,
ListServiceTemplateVersionsPaginator,
ListServiceTemplatesPaginator,
ListServicesPaginator,
ListTagsForResourcePaginator,
)
client: ProtonClient = Session().client("proton")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_component_outputs_paginator: ListComponentOutputsPaginator = client.get_paginator(
"list_component_outputs"
)
list_component_provisioned_resources_paginator: ListComponentProvisionedResourcesPaginator = (
client.get_paginator("list_component_provisioned_resources")
)
list_components_paginator: ListComponentsPaginator = client.get_paginator("list_components")
list_environment_account_connections_paginator: ListEnvironmentAccountConnectionsPaginator = (
client.get_paginator("list_environment_account_connections")
)
list_environment_outputs_paginator: ListEnvironmentOutputsPaginator = client.get_paginator(
"list_environment_outputs"
)
list_environment_provisioned_resources_paginator: ListEnvironmentProvisionedResourcesPaginator = (
client.get_paginator("list_environment_provisioned_resources")
)
list_environment_template_versions_paginator: ListEnvironmentTemplateVersionsPaginator = (
client.get_paginator("list_environment_template_versions")
)
list_environment_templates_paginator: ListEnvironmentTemplatesPaginator = client.get_paginator(
"list_environment_templates"
)
list_environments_paginator: ListEnvironmentsPaginator = client.get_paginator("list_environments")
list_repositories_paginator: ListRepositoriesPaginator = client.get_paginator("list_repositories")
list_repository_sync_definitions_paginator: ListRepositorySyncDefinitionsPaginator = (
client.get_paginator("list_repository_sync_definitions")
)
list_service_instance_outputs_paginator: ListServiceInstanceOutputsPaginator = client.get_paginator(
"list_service_instance_outputs"
)
list_service_instance_provisioned_resources_paginator: ListServiceInstanceProvisionedResourcesPaginator = client.get_paginator(
"list_service_instance_provisioned_resources"
)
list_service_instances_paginator: ListServiceInstancesPaginator = client.get_paginator(
"list_service_instances"
)
list_service_pipeline_outputs_paginator: ListServicePipelineOutputsPaginator = client.get_paginator(
"list_service_pipeline_outputs"
)
list_service_pipeline_provisioned_resources_paginator: ListServicePipelineProvisionedResourcesPaginator = client.get_paginator(
"list_service_pipeline_provisioned_resources"
)
list_service_template_versions_paginator: ListServiceTemplateVersionsPaginator = (
client.get_paginator("list_service_template_versions")
)
list_service_templates_paginator: ListServiceTemplatesPaginator = client.get_paginator(
"list_service_templates"
)
list_services_paginator: ListServicesPaginator = client.get_paginator("list_services")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
"list_tags_for_resource"
)
```
### Waiters annotations
`mypy_boto3_proton.waiter` module contains type annotations for all waiters.
```python
from boto3.session import Session
from mypy_boto3_proton import ProtonClient
from mypy_boto3_proton.waiter import (
ComponentDeletedWaiter,
ComponentDeployedWaiter,
EnvironmentDeployedWaiter,
EnvironmentTemplateVersionRegisteredWaiter,
ServiceCreatedWaiter,
ServiceDeletedWaiter,
ServiceInstanceDeployedWaiter,
ServicePipelineDeployedWaiter,
ServiceTemplateVersionRegisteredWaiter,
ServiceUpdatedWaiter,
)
client: ProtonClient = Session().client("proton")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
component_deleted_waiter: ComponentDeletedWaiter = client.get_waiter("component_deleted")
component_deployed_waiter: ComponentDeployedWaiter = client.get_waiter("component_deployed")
environment_deployed_waiter: EnvironmentDeployedWaiter = client.get_waiter("environment_deployed")
environment_template_version_registered_waiter: EnvironmentTemplateVersionRegisteredWaiter = (
client.get_waiter("environment_template_version_registered")
)
service_created_waiter: ServiceCreatedWaiter = client.get_waiter("service_created")
service_deleted_waiter: ServiceDeletedWaiter = client.get_waiter("service_deleted")
service_instance_deployed_waiter: ServiceInstanceDeployedWaiter = client.get_waiter(
"service_instance_deployed"
)
service_pipeline_deployed_waiter: ServicePipelineDeployedWaiter = client.get_waiter(
"service_pipeline_deployed"
)
service_template_version_registered_waiter: ServiceTemplateVersionRegisteredWaiter = (
client.get_waiter("service_template_version_registered")
)
service_updated_waiter: ServiceUpdatedWaiter = client.get_waiter("service_updated")
```
### Literals
`mypy_boto3_proton.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_proton.literals import (
BlockerStatusType,
BlockerTypeType,
ComponentDeletedWaiterName,
ComponentDeployedWaiterName,
ComponentDeploymentUpdateTypeType,
DeploymentStatusType,
DeploymentUpdateTypeType,
EnvironmentAccountConnectionRequesterAccountTypeType,
EnvironmentAccountConnectionStatusType,
EnvironmentDeployedWaiterName,
EnvironmentTemplateVersionRegisteredWaiterName,
ListComponentOutputsPaginatorName,
ListComponentProvisionedResourcesPaginatorName,
ListComponentsPaginatorName,
ListEnvironmentAccountConnectionsPaginatorName,
ListEnvironmentOutputsPaginatorName,
ListEnvironmentProvisionedResourcesPaginatorName,
ListEnvironmentTemplateVersionsPaginatorName,
ListEnvironmentTemplatesPaginatorName,
ListEnvironmentsPaginatorName,
ListRepositoriesPaginatorName,
ListRepositorySyncDefinitionsPaginatorName,
ListServiceInstanceOutputsPaginatorName,
ListServiceInstanceProvisionedResourcesPaginatorName,
ListServiceInstancesFilterByType,
ListServiceInstancesPaginatorName,
ListServiceInstancesSortByType,
ListServicePipelineOutputsPaginatorName,
ListServicePipelineProvisionedResourcesPaginatorName,
ListServiceTemplateVersionsPaginatorName,
ListServiceTemplatesPaginatorName,
ListServicesPaginatorName,
ListTagsForResourcePaginatorName,
ProvisionedResourceEngineType,
ProvisioningType,
RepositoryProviderType,
RepositorySyncStatusType,
ResourceDeploymentStatusType,
ResourceSyncStatusType,
ServiceCreatedWaiterName,
ServiceDeletedWaiterName,
ServiceInstanceDeployedWaiterName,
ServicePipelineDeployedWaiterName,
ServiceStatusType,
ServiceTemplateSupportedComponentSourceTypeType,
ServiceTemplateVersionRegisteredWaiterName,
ServiceUpdatedWaiterName,
SortOrderType,
SyncTypeType,
TemplateTypeType,
TemplateVersionStatusType,
ProtonServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: BlockerStatusType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_proton.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_proton.type_defs import (
AcceptEnvironmentAccountConnectionInputRequestTypeDef,
EnvironmentAccountConnectionTypeDef,
ResponseMetadataTypeDef,
RepositoryBranchTypeDef,
CancelComponentDeploymentInputRequestTypeDef,
ComponentTypeDef,
CancelEnvironmentDeploymentInputRequestTypeDef,
CancelServiceInstanceDeploymentInputRequestTypeDef,
ServiceInstanceTypeDef,
CancelServicePipelineDeploymentInputRequestTypeDef,
ServicePipelineTypeDef,
CompatibleEnvironmentTemplateInputTypeDef,
CompatibleEnvironmentTemplateTypeDef,
ComponentSummaryTypeDef,
ResourceCountsSummaryTypeDef,
TagTypeDef,
RepositoryBranchInputTypeDef,
EnvironmentTemplateTypeDef,
EnvironmentTemplateVersionTypeDef,
RepositoryTypeDef,
CreateServiceSyncConfigInputRequestTypeDef,
ServiceSyncConfigTypeDef,
ServiceTemplateTypeDef,
CreateTemplateSyncConfigInputRequestTypeDef,
TemplateSyncConfigTypeDef,
DeleteComponentInputRequestTypeDef,
DeleteEnvironmentAccountConnectionInputRequestTypeDef,
DeleteEnvironmentInputRequestTypeDef,
DeleteEnvironmentTemplateInputRequestTypeDef,
DeleteEnvironmentTemplateVersionInputRequestTypeDef,
DeleteRepositoryInputRequestTypeDef,
DeleteServiceInputRequestTypeDef,
DeleteServiceSyncConfigInputRequestTypeDef,
DeleteServiceTemplateInputRequestTypeDef,
DeleteServiceTemplateVersionInputRequestTypeDef,
DeleteTemplateSyncConfigInputRequestTypeDef,
EnvironmentAccountConnectionSummaryTypeDef,
EnvironmentSummaryTypeDef,
EnvironmentTemplateFilterTypeDef,
EnvironmentTemplateSummaryTypeDef,
EnvironmentTemplateVersionSummaryTypeDef,
WaiterConfigTypeDef,
GetComponentInputRequestTypeDef,
GetEnvironmentAccountConnectionInputRequestTypeDef,
GetEnvironmentInputRequestTypeDef,
GetEnvironmentTemplateInputRequestTypeDef,
GetEnvironmentTemplateVersionInputRequestTypeDef,
GetRepositoryInputRequestTypeDef,
GetRepositorySyncStatusInputRequestTypeDef,
GetServiceInputRequestTypeDef,
GetServiceInstanceInputRequestTypeDef,
GetServiceInstanceSyncStatusInputRequestTypeDef,
RevisionTypeDef,
GetServiceSyncBlockerSummaryInputRequestTypeDef,
GetServiceSyncConfigInputRequestTypeDef,
GetServiceTemplateInputRequestTypeDef,
GetServiceTemplateVersionInputRequestTypeDef,
GetTemplateSyncConfigInputRequestTypeDef,
GetTemplateSyncStatusInputRequestTypeDef,
PaginatorConfigTypeDef,
ListComponentOutputsInputRequestTypeDef,
OutputTypeDef,
ListComponentProvisionedResourcesInputRequestTypeDef,
ProvisionedResourceTypeDef,
ListComponentsInputRequestTypeDef,
ListEnvironmentAccountConnectionsInputRequestTypeDef,
ListEnvironmentOutputsInputRequestTypeDef,
ListEnvironmentProvisionedResourcesInputRequestTypeDef,
ListEnvironmentTemplateVersionsInputRequestTypeDef,
ListEnvironmentTemplatesInputRequestTypeDef,
ListRepositoriesInputRequestTypeDef,
RepositorySummaryTypeDef,
ListRepositorySyncDefinitionsInputRequestTypeDef,
RepositorySyncDefinitionTypeDef,
ListServiceInstanceOutputsInputRequestTypeDef,
ListServiceInstanceProvisionedResourcesInputRequestTypeDef,
ListServiceInstancesFilterTypeDef,
ServiceInstanceSummaryTypeDef,
ListServicePipelineOutputsInputRequestTypeDef,
ListServicePipelineProvisionedResourcesInputRequestTypeDef,
ListServiceTemplateVersionsInputRequestTypeDef,
ServiceTemplateVersionSummaryTypeDef,
ListServiceTemplatesInputRequestTypeDef,
ServiceTemplateSummaryTypeDef,
ListServicesInputRequestTypeDef,
ServiceSummaryTypeDef,
ListTagsForResourceInputRequestTypeDef,
RejectEnvironmentAccountConnectionInputRequestTypeDef,
RepositorySyncEventTypeDef,
ResourceSyncEventTypeDef,
S3ObjectSourceTypeDef,
SyncBlockerContextTypeDef,
UntagResourceInputRequestTypeDef,
UpdateComponentInputRequestTypeDef,
UpdateEnvironmentAccountConnectionInputRequestTypeDef,
UpdateEnvironmentTemplateInputRequestTypeDef,
UpdateEnvironmentTemplateVersionInputRequestTypeDef,
UpdateServiceInputRequestTypeDef,
UpdateServiceInstanceInputRequestTypeDef,
UpdateServicePipelineInputRequestTypeDef,
UpdateServiceSyncBlockerInputRequestTypeDef,
UpdateServiceSyncConfigInputRequestTypeDef,
UpdateServiceTemplateInputRequestTypeDef,
UpdateTemplateSyncConfigInputRequestTypeDef,
AcceptEnvironmentAccountConnectionOutputTypeDef,
CreateEnvironmentAccountConnectionOutputTypeDef,
DeleteEnvironmentAccountConnectionOutputTypeDef,
GetEnvironmentAccountConnectionOutputTypeDef,
RejectEnvironmentAccountConnectionOutputTypeDef,
UpdateEnvironmentAccountConnectionOutputTypeDef,
AccountSettingsTypeDef,
EnvironmentTypeDef,
CancelComponentDeploymentOutputTypeDef,
CreateComponentOutputTypeDef,
DeleteComponentOutputTypeDef,
GetComponentOutputTypeDef,
UpdateComponentOutputTypeDef,
CancelServiceInstanceDeploymentOutputTypeDef,
CreateServiceInstanceOutputTypeDef,
GetServiceInstanceOutputTypeDef,
UpdateServiceInstanceOutputTypeDef,
CancelServicePipelineDeploymentOutputTypeDef,
ServiceTypeDef,
UpdateServicePipelineOutputTypeDef,
UpdateServiceTemplateVersionInputRequestTypeDef,
ServiceTemplateVersionTypeDef,
ListComponentsOutputTypeDef,
CountsSummaryTypeDef,
CreateComponentInputRequestTypeDef,
CreateEnvironmentAccountConnectionInputRequestTypeDef,
CreateEnvironmentTemplateInputRequestTypeDef,
CreateRepositoryInputRequestTypeDef,
CreateServiceInputRequestTypeDef,
CreateServiceInstanceInputRequestTypeDef,
CreateServiceTemplateInputRequestTypeDef,
ListTagsForResourceOutputTypeDef,
TagResourceInputRequestTypeDef,
CreateEnvironmentInputRequestTypeDef,
UpdateAccountSettingsInputRequestTypeDef,
UpdateEnvironmentInputRequestTypeDef,
CreateEnvironmentTemplateOutputTypeDef,
DeleteEnvironmentTemplateOutputTypeDef,
GetEnvironmentTemplateOutputTypeDef,
UpdateEnvironmentTemplateOutputTypeDef,
CreateEnvironmentTemplateVersionOutputTypeDef,
DeleteEnvironmentTemplateVersionOutputTypeDef,
GetEnvironmentTemplateVersionOutputTypeDef,
UpdateEnvironmentTemplateVersionOutputTypeDef,
CreateRepositoryOutputTypeDef,
DeleteRepositoryOutputTypeDef,
GetRepositoryOutputTypeDef,
CreateServiceSyncConfigOutputTypeDef,
DeleteServiceSyncConfigOutputTypeDef,
GetServiceSyncConfigOutputTypeDef,
UpdateServiceSyncConfigOutputTypeDef,
CreateServiceTemplateOutputTypeDef,
DeleteServiceTemplateOutputTypeDef,
GetServiceTemplateOutputTypeDef,
UpdateServiceTemplateOutputTypeDef,
CreateTemplateSyncConfigOutputTypeDef,
DeleteTemplateSyncConfigOutputTypeDef,
GetTemplateSyncConfigOutputTypeDef,
UpdateTemplateSyncConfigOutputTypeDef,
ListEnvironmentAccountConnectionsOutputTypeDef,
ListEnvironmentsOutputTypeDef,
ListEnvironmentsInputRequestTypeDef,
ListEnvironmentTemplatesOutputTypeDef,
ListEnvironmentTemplateVersionsOutputTypeDef,
GetComponentInputComponentDeletedWaitTypeDef,
GetComponentInputComponentDeployedWaitTypeDef,
GetEnvironmentInputEnvironmentDeployedWaitTypeDef,
GetEnvironmentTemplateVersionInputEnvironmentTemplateVersionRegisteredWaitTypeDef,
GetServiceInputServiceCreatedWaitTypeDef,
GetServiceInputServiceDeletedWaitTypeDef,
GetServiceInputServicePipelineDeployedWaitTypeDef,
GetServiceInputServiceUpdatedWaitTypeDef,
GetServiceInstanceInputServiceInstanceDeployedWaitTypeDef,
GetServiceTemplateVersionInputServiceTemplateVersionRegisteredWaitTypeDef,
ListComponentOutputsInputListComponentOutputsPaginateTypeDef,
ListComponentProvisionedResourcesInputListComponentProvisionedResourcesPaginateTypeDef,
ListComponentsInputListComponentsPaginateTypeDef,
ListEnvironmentAccountConnectionsInputListEnvironmentAccountConnectionsPaginateTypeDef,
ListEnvironmentOutputsInputListEnvironmentOutputsPaginateTypeDef,
ListEnvironmentProvisionedResourcesInputListEnvironmentProvisionedResourcesPaginateTypeDef,
ListEnvironmentTemplateVersionsInputListEnvironmentTemplateVersionsPaginateTypeDef,
ListEnvironmentTemplatesInputListEnvironmentTemplatesPaginateTypeDef,
ListEnvironmentsInputListEnvironmentsPaginateTypeDef,
ListRepositoriesInputListRepositoriesPaginateTypeDef,
ListRepositorySyncDefinitionsInputListRepositorySyncDefinitionsPaginateTypeDef,
ListServiceInstanceOutputsInputListServiceInstanceOutputsPaginateTypeDef,
ListServiceInstanceProvisionedResourcesInputListServiceInstanceProvisionedResourcesPaginateTypeDef,
ListServicePipelineOutputsInputListServicePipelineOutputsPaginateTypeDef,
ListServicePipelineProvisionedResourcesInputListServicePipelineProvisionedResourcesPaginateTypeDef,
ListServiceTemplateVersionsInputListServiceTemplateVersionsPaginateTypeDef,
ListServiceTemplatesInputListServiceTemplatesPaginateTypeDef,
ListServicesInputListServicesPaginateTypeDef,
ListTagsForResourceInputListTagsForResourcePaginateTypeDef,
ListComponentOutputsOutputTypeDef,
ListEnvironmentOutputsOutputTypeDef,
ListServiceInstanceOutputsOutputTypeDef,
ListServicePipelineOutputsOutputTypeDef,
NotifyResourceDeploymentStatusChangeInputRequestTypeDef,
ListComponentProvisionedResourcesOutputTypeDef,
ListEnvironmentProvisionedResourcesOutputTypeDef,
ListServiceInstanceProvisionedResourcesOutputTypeDef,
ListServicePipelineProvisionedResourcesOutputTypeDef,
ListRepositoriesOutputTypeDef,
ListRepositorySyncDefinitionsOutputTypeDef,
ListServiceInstancesInputListServiceInstancesPaginateTypeDef,
ListServiceInstancesInputRequestTypeDef,
ListServiceInstancesOutputTypeDef,
ListServiceTemplateVersionsOutputTypeDef,
ListServiceTemplatesOutputTypeDef,
ListServicesOutputTypeDef,
RepositorySyncAttemptTypeDef,
ResourceSyncAttemptTypeDef,
TemplateVersionSourceInputTypeDef,
SyncBlockerTypeDef,
GetAccountSettingsOutputTypeDef,
UpdateAccountSettingsOutputTypeDef,
CancelEnvironmentDeploymentOutputTypeDef,
CreateEnvironmentOutputTypeDef,
DeleteEnvironmentOutputTypeDef,
GetEnvironmentOutputTypeDef,
UpdateEnvironmentOutputTypeDef,
CreateServiceOutputTypeDef,
DeleteServiceOutputTypeDef,
GetServiceOutputTypeDef,
UpdateServiceOutputTypeDef,
CreateServiceTemplateVersionOutputTypeDef,
DeleteServiceTemplateVersionOutputTypeDef,
GetServiceTemplateVersionOutputTypeDef,
UpdateServiceTemplateVersionOutputTypeDef,
GetResourcesSummaryOutputTypeDef,
GetRepositorySyncStatusOutputTypeDef,
GetServiceInstanceSyncStatusOutputTypeDef,
GetTemplateSyncStatusOutputTypeDef,
CreateEnvironmentTemplateVersionInputRequestTypeDef,
CreateServiceTemplateVersionInputRequestTypeDef,
ServiceSyncBlockerSummaryTypeDef,
UpdateServiceSyncBlockerOutputTypeDef,
GetServiceSyncBlockerSummaryOutputTypeDef,
)
def get_structure() -> AcceptEnvironmentAccountConnectionInputRequestTypeDef:
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 drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from `botocore` schemas.
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [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`, `aiobotocore` and `aioboto3`
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.resource` calls
- Auto discovery of types for `session.client` and `session.resource` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-proton` 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_proton/)
## 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-proton-1.26.108
%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-proton -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Wed Apr 12 2023 Python_Bot - 1.26.108-1
- Package Spec generated