<a id="mypy-boto3-proton"></a>
# mypy-boto3-proton
[![PyPI - mypy-boto3-proton](https://img.shields.io/pypi/v/mypy-boto3-proton.svg?color=blue)](https://pypi.org/project/mypy-boto3-proton)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-proton.svg?color=blue)](https://pypi.org/project/mypy-boto3-proton)
[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_proton/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-proton?color=blue)](https://pypistats.org/packages/mypy-boto3-proton)
![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
Type annotations for
[boto3.Proton 1.28.3](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.15.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-proton docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_proton/).
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
- [mypy-boto3-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)
<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 `Proton`.
<a id="from-pypi-with-pip"></a>
### 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
```
<a id="how-to-uninstall"></a>
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-proton
```
<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[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.
<a id="pycharm"></a>
### 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.
<a id="emacs"></a>
### 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.
<a id="sublime-text"></a>
### 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.
<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[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.
<a id="pyright"></a>
### 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.
<a id="explicit-type-annotations"></a>
## Explicit type annotations
<a id="client-annotations"></a>
### 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
```
<a id="paginators-annotations"></a>
### 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,
ListDeploymentsPaginator,
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_deployments_paginator: ListDeploymentsPaginator = client.get_paginator("list_deployments")
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"
)
```
<a id="waiters-annotations"></a>
### 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")
```
<a id="literals"></a>
### 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,
DeploymentTargetResourceTypeType,
DeploymentUpdateTypeType,
EnvironmentAccountConnectionRequesterAccountTypeType,
EnvironmentAccountConnectionStatusType,
EnvironmentDeployedWaiterName,
EnvironmentTemplateVersionRegisteredWaiterName,
ListComponentOutputsPaginatorName,
ListComponentProvisionedResourcesPaginatorName,
ListComponentsPaginatorName,
ListDeploymentsPaginatorName,
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:
...
```
<a id="typed-dictionaries"></a>
### 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,
RepositoryBranchTypeDef,
CancelComponentDeploymentInputRequestTypeDef,
ComponentTypeDef,
CancelEnvironmentDeploymentInputRequestTypeDef,
CancelServiceInstanceDeploymentInputRequestTypeDef,
ServiceInstanceTypeDef,
CancelServicePipelineDeploymentInputRequestTypeDef,
ServicePipelineTypeDef,
CompatibleEnvironmentTemplateInputTypeDef,
CompatibleEnvironmentTemplateTypeDef,
ComponentStateTypeDef,
ComponentSummaryTypeDef,
ResourceCountsSummaryTypeDef,
TagTypeDef,
RepositoryBranchInputTypeDef,
EnvironmentTemplateTypeDef,
EnvironmentTemplateVersionTypeDef,
RepositoryTypeDef,
CreateServiceSyncConfigInputRequestTypeDef,
ServiceSyncConfigTypeDef,
ServiceTemplateTypeDef,
CreateTemplateSyncConfigInputRequestTypeDef,
TemplateSyncConfigTypeDef,
DeleteComponentInputRequestTypeDef,
DeleteDeploymentInputRequestTypeDef,
DeleteEnvironmentAccountConnectionInputRequestTypeDef,
DeleteEnvironmentInputRequestTypeDef,
DeleteEnvironmentTemplateInputRequestTypeDef,
DeleteEnvironmentTemplateVersionInputRequestTypeDef,
DeleteRepositoryInputRequestTypeDef,
DeleteServiceInputRequestTypeDef,
DeleteServiceSyncConfigInputRequestTypeDef,
DeleteServiceTemplateInputRequestTypeDef,
DeleteServiceTemplateVersionInputRequestTypeDef,
DeleteTemplateSyncConfigInputRequestTypeDef,
EnvironmentStateTypeDef,
ServiceInstanceStateTypeDef,
ServicePipelineStateTypeDef,
DeploymentSummaryTypeDef,
EnvironmentAccountConnectionSummaryTypeDef,
EnvironmentSummaryTypeDef,
EnvironmentTemplateFilterTypeDef,
EnvironmentTemplateSummaryTypeDef,
EnvironmentTemplateVersionSummaryTypeDef,
WaiterConfigTypeDef,
GetComponentInputRequestTypeDef,
GetDeploymentInputRequestTypeDef,
GetEnvironmentAccountConnectionInputRequestTypeDef,
GetEnvironmentInputRequestTypeDef,
GetEnvironmentTemplateInputRequestTypeDef,
GetEnvironmentTemplateVersionInputRequestTypeDef,
GetRepositoryInputRequestTypeDef,
GetRepositorySyncStatusInputRequestTypeDef,
GetServiceInputRequestTypeDef,
GetServiceInstanceInputRequestTypeDef,
GetServiceInstanceSyncStatusInputRequestTypeDef,
RevisionTypeDef,
GetServiceSyncBlockerSummaryInputRequestTypeDef,
GetServiceSyncConfigInputRequestTypeDef,
GetServiceTemplateInputRequestTypeDef,
GetServiceTemplateVersionInputRequestTypeDef,
GetTemplateSyncConfigInputRequestTypeDef,
GetTemplateSyncStatusInputRequestTypeDef,
ListComponentOutputsInputListComponentOutputsPaginateTypeDef,
ListComponentOutputsInputRequestTypeDef,
OutputTypeDef,
ListComponentProvisionedResourcesInputListComponentProvisionedResourcesPaginateTypeDef,
ListComponentProvisionedResourcesInputRequestTypeDef,
ProvisionedResourceTypeDef,
ListComponentsInputListComponentsPaginateTypeDef,
ListComponentsInputRequestTypeDef,
ListDeploymentsInputListDeploymentsPaginateTypeDef,
ListDeploymentsInputRequestTypeDef,
ListEnvironmentAccountConnectionsInputListEnvironmentAccountConnectionsPaginateTypeDef,
ListEnvironmentAccountConnectionsInputRequestTypeDef,
ListEnvironmentOutputsInputListEnvironmentOutputsPaginateTypeDef,
ListEnvironmentOutputsInputRequestTypeDef,
ListEnvironmentProvisionedResourcesInputListEnvironmentProvisionedResourcesPaginateTypeDef,
ListEnvironmentProvisionedResourcesInputRequestTypeDef,
ListEnvironmentTemplateVersionsInputListEnvironmentTemplateVersionsPaginateTypeDef,
ListEnvironmentTemplateVersionsInputRequestTypeDef,
ListEnvironmentTemplatesInputListEnvironmentTemplatesPaginateTypeDef,
ListEnvironmentTemplatesInputRequestTypeDef,
ListRepositoriesInputListRepositoriesPaginateTypeDef,
ListRepositoriesInputRequestTypeDef,
RepositorySummaryTypeDef,
ListRepositorySyncDefinitionsInputListRepositorySyncDefinitionsPaginateTypeDef,
ListRepositorySyncDefinitionsInputRequestTypeDef,
RepositorySyncDefinitionTypeDef,
ListServiceInstanceOutputsInputListServiceInstanceOutputsPaginateTypeDef,
ListServiceInstanceOutputsInputRequestTypeDef,
ListServiceInstanceProvisionedResourcesInputListServiceInstanceProvisionedResourcesPaginateTypeDef,
ListServiceInstanceProvisionedResourcesInputRequestTypeDef,
ListServiceInstancesFilterTypeDef,
ServiceInstanceSummaryTypeDef,
ListServicePipelineOutputsInputListServicePipelineOutputsPaginateTypeDef,
ListServicePipelineOutputsInputRequestTypeDef,
ListServicePipelineProvisionedResourcesInputListServicePipelineProvisionedResourcesPaginateTypeDef,
ListServicePipelineProvisionedResourcesInputRequestTypeDef,
ListServiceTemplateVersionsInputListServiceTemplateVersionsPaginateTypeDef,
ListServiceTemplateVersionsInputRequestTypeDef,
ServiceTemplateVersionSummaryTypeDef,
ListServiceTemplatesInputListServiceTemplatesPaginateTypeDef,
ListServiceTemplatesInputRequestTypeDef,
ServiceTemplateSummaryTypeDef,
ListServicesInputListServicesPaginateTypeDef,
ListServicesInputRequestTypeDef,
ServiceSummaryTypeDef,
ListTagsForResourceInputListTagsForResourcePaginateTypeDef,
ListTagsForResourceInputRequestTypeDef,
TagOutputTypeDef,
PaginatorConfigTypeDef,
RejectEnvironmentAccountConnectionInputRequestTypeDef,
RepositorySyncEventTypeDef,
ResourceSyncEventTypeDef,
ResponseMetadataTypeDef,
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,
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,
DeploymentStateTypeDef,
ListDeploymentsOutputTypeDef,
ListEnvironmentAccountConnectionsOutputTypeDef,
ListEnvironmentsOutputTypeDef,
ListEnvironmentsInputListEnvironmentsPaginateTypeDef,
ListEnvironmentsInputRequestTypeDef,
ListEnvironmentTemplatesOutputTypeDef,
ListEnvironmentTemplateVersionsOutputTypeDef,
GetComponentInputComponentDeletedWaitTypeDef,
GetComponentInputComponentDeployedWaitTypeDef,
GetEnvironmentInputEnvironmentDeployedWaitTypeDef,
GetEnvironmentTemplateVersionInputEnvironmentTemplateVersionRegisteredWaitTypeDef,
GetServiceInputServiceCreatedWaitTypeDef,
GetServiceInputServiceDeletedWaitTypeDef,
GetServiceInputServicePipelineDeployedWaitTypeDef,
GetServiceInputServiceUpdatedWaitTypeDef,
GetServiceInstanceInputServiceInstanceDeployedWaitTypeDef,
GetServiceTemplateVersionInputServiceTemplateVersionRegisteredWaitTypeDef,
ListComponentOutputsOutputTypeDef,
ListEnvironmentOutputsOutputTypeDef,
ListServiceInstanceOutputsOutputTypeDef,
ListServicePipelineOutputsOutputTypeDef,
NotifyResourceDeploymentStatusChangeInputRequestTypeDef,
ListComponentProvisionedResourcesOutputTypeDef,
ListEnvironmentProvisionedResourcesOutputTypeDef,
ListServiceInstanceProvisionedResourcesOutputTypeDef,
ListServicePipelineProvisionedResourcesOutputTypeDef,
ListRepositoriesOutputTypeDef,
ListRepositorySyncDefinitionsOutputTypeDef,
ListServiceInstancesInputListServiceInstancesPaginateTypeDef,
ListServiceInstancesInputRequestTypeDef,
ListServiceInstancesOutputTypeDef,
ListServiceTemplateVersionsOutputTypeDef,
ListServiceTemplatesOutputTypeDef,
ListServicesOutputTypeDef,
ListTagsForResourceOutputTypeDef,
RepositorySyncAttemptTypeDef,
ResourceSyncAttemptTypeDef,
TemplateVersionSourceInputTypeDef,
SyncBlockerTypeDef,
GetAccountSettingsOutputTypeDef,
UpdateAccountSettingsOutputTypeDef,
CancelEnvironmentDeploymentOutputTypeDef,
CreateEnvironmentOutputTypeDef,
DeleteEnvironmentOutputTypeDef,
GetEnvironmentOutputTypeDef,
UpdateEnvironmentOutputTypeDef,
CreateServiceOutputTypeDef,
DeleteServiceOutputTypeDef,
GetServiceOutputTypeDef,
UpdateServiceOutputTypeDef,
CreateServiceTemplateVersionOutputTypeDef,
DeleteServiceTemplateVersionOutputTypeDef,
GetServiceTemplateVersionOutputTypeDef,
UpdateServiceTemplateVersionOutputTypeDef,
GetResourcesSummaryOutputTypeDef,
DeploymentTypeDef,
GetRepositorySyncStatusOutputTypeDef,
GetServiceInstanceSyncStatusOutputTypeDef,
GetTemplateSyncStatusOutputTypeDef,
CreateEnvironmentTemplateVersionInputRequestTypeDef,
CreateServiceTemplateVersionInputRequestTypeDef,
ServiceSyncBlockerSummaryTypeDef,
UpdateServiceSyncBlockerOutputTypeDef,
DeleteDeploymentOutputTypeDef,
GetDeploymentOutputTypeDef,
GetServiceSyncBlockerSummaryOutputTypeDef,
)
def get_structure() -> AcceptEnvironmentAccountConnectionInputRequestTypeDef:
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 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.
<a id="what's-new"></a>
## What's new
<a id="implemented-features"></a>
### 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
<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-proton` 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_proton/)
<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.
Raw data
{
"_id": null,
"home_page": "https://github.com/youtype/mypy_boto3_builder",
"name": "mypy-boto3-proton",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "boto3 proton type-annotations boto3-stubs mypy typeshed autocomplete",
"author": "Vlad Emelianov",
"author_email": "vlad.emelianov.nz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9b/e8/5a2531247a6e5ea71af8a8b1f47c9cbf96834d3940c9c00c7c35261178f2/mypy-boto3-proton-1.28.3.post2.tar.gz",
"platform": null,
"description": "<a id=\"mypy-boto3-proton\"></a>\n\n# mypy-boto3-proton\n\n[![PyPI - mypy-boto3-proton](https://img.shields.io/pypi/v/mypy-boto3-proton.svg?color=blue)](https://pypi.org/project/mypy-boto3-proton)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-proton.svg?color=blue)](https://pypi.org/project/mypy-boto3-proton)\n[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_proton/)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-proton?color=blue)](https://pypistats.org/packages/mypy-boto3-proton)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nType annotations for\n[boto3.Proton 1.28.3](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/proton.html#Proton)\nservice compatible with [VSCode](https://code.visualstudio.com/),\n[PyCharm](https://www.jetbrains.com/pycharm/),\n[Emacs](https://www.gnu.org/software/emacs/),\n[Sublime Text](https://www.sublimetext.com/),\n[mypy](https://github.com/python/mypy),\n[pyright](https://github.com/microsoft/pyright) and other tools.\n\nGenerated by\n[mypy-boto3-builder 7.15.0](https://github.com/youtype/mypy_boto3_builder).\n\nMore information can be found on\n[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in\n[mypy-boto3-proton docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_proton/).\n\nSee how it helps to find and fix potential bugs:\n\n![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)\n\n- [mypy-boto3-proton](#mypy-boto3-proton)\n - [How to install](#how-to-install)\n - [VSCode extension](#vscode-extension)\n - [From PyPI with pip](#from-pypi-with-pip)\n - [How to uninstall](#how-to-uninstall)\n - [Usage](#usage)\n - [VSCode](#vscode)\n - [PyCharm](#pycharm)\n - [Emacs](#emacs)\n - [Sublime Text](#sublime-text)\n - [Other IDEs](#other-ides)\n - [mypy](#mypy)\n - [pyright](#pyright)\n - [Explicit type annotations](#explicit-type-annotations)\n - [Client annotations](#client-annotations)\n - [Paginators annotations](#paginators-annotations)\n - [Waiters annotations](#waiters-annotations)\n - [Literals](#literals)\n - [Typed dictionaries](#typed-dictionaries)\n - [How it works](#how-it-works)\n - [What's new](#what's-new)\n - [Implemented features](#implemented-features)\n - [Latest changes](#latest-changes)\n - [Versioning](#versioning)\n - [Thank you](#thank-you)\n - [Documentation](#documentation)\n - [Support and contributing](#support-and-contributing)\n\n<a id=\"how-to-install\"></a>\n\n## How to install\n\n<a id=\"vscode-extension\"></a>\n\n### VSCode extension\n\nAdd\n[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)\nextension to your VSCode and run `AWS boto3: Quick Start` command.\n\nClick `Modify` and select `boto3 common` and `Proton`.\n\n<a id=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `boto3-stubs` for `Proton` service.\n\n```bash\n# install with boto3 type annotations\npython -m pip install 'boto3-stubs[proton]'\n\n\n# Lite version does not provide session.client/resource overloads\n# it is more RAM-friendly, but requires explicit type annotations\npython -m pip install 'boto3-stubs-lite[proton]'\n\n\n# standalone installation\npython -m pip install mypy-boto3-proton\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y mypy-boto3-proton\n```\n\n<a id=\"usage\"></a>\n\n## Usage\n\n<a id=\"vscode\"></a>\n\n### VSCode\n\n- Install\n [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)\n- Install\n [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)\n- Set `Pylance` as your Python Language Server\n- Install `boto3-stubs[proton]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[proton]'\n```\n\nBoth type checking and code completion should now work. No explicit type\nannotations required, write your `boto3` code as usual.\n\n<a id=\"pycharm\"></a>\n\n### PyCharm\n\nInstall `boto3-stubs-lite[proton]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs-lite[proton]'`\n```\n\nBoth type checking and code completion should now work. Explicit type\nannotations **are required**.\n\nUse `boto3-stubs` package instead for implicit type discovery.\n\n<a id=\"emacs\"></a>\n\n### Emacs\n\n- Install `boto3-stubs` with services you use in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[proton]'\n```\n\n- Install [use-package](https://github.com/jwiegley/use-package),\n [lsp](https://github.com/emacs-lsp/lsp-mode/),\n [company](https://github.com/company-mode/company-mode) and\n [flycheck](https://github.com/flycheck/flycheck) packages\n- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package\n\n```elisp\n(use-package lsp-pyright\n :ensure t\n :hook (python-mode . (lambda ()\n (require 'lsp-pyright)\n (lsp))) ; or lsp-deferred\n :init (when (executable-find \"python3\")\n (setq lsp-pyright-python-executable-cmd \"python3\"))\n )\n```\n\n- Make sure emacs uses the environment where you have installed `boto3-stubs`\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"sublime-text\"></a>\n\n### Sublime Text\n\n- Install `boto3-stubs[proton]` with services you use in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[proton]'\n```\n\n- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"other-ides\"></a>\n\n### Other IDEs\n\nNot tested, but as long as your IDE supports `mypy` or `pyright`, everything\nshould work.\n\n<a id=\"mypy\"></a>\n\n### mypy\n\n- Install `mypy`: `python -m pip install mypy`\n- Install `boto3-stubs[proton]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[proton]'`\n```\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"pyright\"></a>\n\n### pyright\n\n- Install `pyright`: `npm i -g pyright`\n- Install `boto3-stubs[proton]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[proton]'\n```\n\nOptionally, you can install `boto3-stubs` to `typings` folder.\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"explicit-type-annotations\"></a>\n\n## Explicit type annotations\n\n<a id=\"client-annotations\"></a>\n\n### Client annotations\n\n`ProtonClient` provides annotations for `boto3.client(\"proton\")`.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_proton import ProtonClient\n\nclient: ProtonClient = Session().client(\"proton\")\n\n# now client usage is checked by mypy and IDE should provide code completion\n```\n\n<a id=\"paginators-annotations\"></a>\n\n### Paginators annotations\n\n`mypy_boto3_proton.paginator` module contains type annotations for all\npaginators.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_proton import ProtonClient\nfrom mypy_boto3_proton.paginator import (\n ListComponentOutputsPaginator,\n ListComponentProvisionedResourcesPaginator,\n ListComponentsPaginator,\n ListDeploymentsPaginator,\n ListEnvironmentAccountConnectionsPaginator,\n ListEnvironmentOutputsPaginator,\n ListEnvironmentProvisionedResourcesPaginator,\n ListEnvironmentTemplateVersionsPaginator,\n ListEnvironmentTemplatesPaginator,\n ListEnvironmentsPaginator,\n ListRepositoriesPaginator,\n ListRepositorySyncDefinitionsPaginator,\n ListServiceInstanceOutputsPaginator,\n ListServiceInstanceProvisionedResourcesPaginator,\n ListServiceInstancesPaginator,\n ListServicePipelineOutputsPaginator,\n ListServicePipelineProvisionedResourcesPaginator,\n ListServiceTemplateVersionsPaginator,\n ListServiceTemplatesPaginator,\n ListServicesPaginator,\n ListTagsForResourcePaginator,\n)\n\nclient: ProtonClient = Session().client(\"proton\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\nlist_component_outputs_paginator: ListComponentOutputsPaginator = client.get_paginator(\n \"list_component_outputs\"\n)\nlist_component_provisioned_resources_paginator: ListComponentProvisionedResourcesPaginator = (\n client.get_paginator(\"list_component_provisioned_resources\")\n)\nlist_components_paginator: ListComponentsPaginator = client.get_paginator(\"list_components\")\nlist_deployments_paginator: ListDeploymentsPaginator = client.get_paginator(\"list_deployments\")\nlist_environment_account_connections_paginator: ListEnvironmentAccountConnectionsPaginator = (\n client.get_paginator(\"list_environment_account_connections\")\n)\nlist_environment_outputs_paginator: ListEnvironmentOutputsPaginator = client.get_paginator(\n \"list_environment_outputs\"\n)\nlist_environment_provisioned_resources_paginator: ListEnvironmentProvisionedResourcesPaginator = (\n client.get_paginator(\"list_environment_provisioned_resources\")\n)\nlist_environment_template_versions_paginator: ListEnvironmentTemplateVersionsPaginator = (\n client.get_paginator(\"list_environment_template_versions\")\n)\nlist_environment_templates_paginator: ListEnvironmentTemplatesPaginator = client.get_paginator(\n \"list_environment_templates\"\n)\nlist_environments_paginator: ListEnvironmentsPaginator = client.get_paginator(\"list_environments\")\nlist_repositories_paginator: ListRepositoriesPaginator = client.get_paginator(\"list_repositories\")\nlist_repository_sync_definitions_paginator: ListRepositorySyncDefinitionsPaginator = (\n client.get_paginator(\"list_repository_sync_definitions\")\n)\nlist_service_instance_outputs_paginator: ListServiceInstanceOutputsPaginator = client.get_paginator(\n \"list_service_instance_outputs\"\n)\nlist_service_instance_provisioned_resources_paginator: ListServiceInstanceProvisionedResourcesPaginator = client.get_paginator(\n \"list_service_instance_provisioned_resources\"\n)\nlist_service_instances_paginator: ListServiceInstancesPaginator = client.get_paginator(\n \"list_service_instances\"\n)\nlist_service_pipeline_outputs_paginator: ListServicePipelineOutputsPaginator = client.get_paginator(\n \"list_service_pipeline_outputs\"\n)\nlist_service_pipeline_provisioned_resources_paginator: ListServicePipelineProvisionedResourcesPaginator = client.get_paginator(\n \"list_service_pipeline_provisioned_resources\"\n)\nlist_service_template_versions_paginator: ListServiceTemplateVersionsPaginator = (\n client.get_paginator(\"list_service_template_versions\")\n)\nlist_service_templates_paginator: ListServiceTemplatesPaginator = client.get_paginator(\n \"list_service_templates\"\n)\nlist_services_paginator: ListServicesPaginator = client.get_paginator(\"list_services\")\nlist_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(\n \"list_tags_for_resource\"\n)\n```\n\n<a id=\"waiters-annotations\"></a>\n\n### Waiters annotations\n\n`mypy_boto3_proton.waiter` module contains type annotations for all waiters.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_proton import ProtonClient\nfrom mypy_boto3_proton.waiter import (\n ComponentDeletedWaiter,\n ComponentDeployedWaiter,\n EnvironmentDeployedWaiter,\n EnvironmentTemplateVersionRegisteredWaiter,\n ServiceCreatedWaiter,\n ServiceDeletedWaiter,\n ServiceInstanceDeployedWaiter,\n ServicePipelineDeployedWaiter,\n ServiceTemplateVersionRegisteredWaiter,\n ServiceUpdatedWaiter,\n)\n\nclient: ProtonClient = Session().client(\"proton\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\ncomponent_deleted_waiter: ComponentDeletedWaiter = client.get_waiter(\"component_deleted\")\ncomponent_deployed_waiter: ComponentDeployedWaiter = client.get_waiter(\"component_deployed\")\nenvironment_deployed_waiter: EnvironmentDeployedWaiter = client.get_waiter(\"environment_deployed\")\nenvironment_template_version_registered_waiter: EnvironmentTemplateVersionRegisteredWaiter = (\n client.get_waiter(\"environment_template_version_registered\")\n)\nservice_created_waiter: ServiceCreatedWaiter = client.get_waiter(\"service_created\")\nservice_deleted_waiter: ServiceDeletedWaiter = client.get_waiter(\"service_deleted\")\nservice_instance_deployed_waiter: ServiceInstanceDeployedWaiter = client.get_waiter(\n \"service_instance_deployed\"\n)\nservice_pipeline_deployed_waiter: ServicePipelineDeployedWaiter = client.get_waiter(\n \"service_pipeline_deployed\"\n)\nservice_template_version_registered_waiter: ServiceTemplateVersionRegisteredWaiter = (\n client.get_waiter(\"service_template_version_registered\")\n)\nservice_updated_waiter: ServiceUpdatedWaiter = client.get_waiter(\"service_updated\")\n```\n\n<a id=\"literals\"></a>\n\n### Literals\n\n`mypy_boto3_proton.literals` module contains literals extracted from shapes\nthat can be used in user code for type checking.\n\n```python\nfrom mypy_boto3_proton.literals import (\n BlockerStatusType,\n BlockerTypeType,\n ComponentDeletedWaiterName,\n ComponentDeployedWaiterName,\n ComponentDeploymentUpdateTypeType,\n DeploymentStatusType,\n DeploymentTargetResourceTypeType,\n DeploymentUpdateTypeType,\n EnvironmentAccountConnectionRequesterAccountTypeType,\n EnvironmentAccountConnectionStatusType,\n EnvironmentDeployedWaiterName,\n EnvironmentTemplateVersionRegisteredWaiterName,\n ListComponentOutputsPaginatorName,\n ListComponentProvisionedResourcesPaginatorName,\n ListComponentsPaginatorName,\n ListDeploymentsPaginatorName,\n ListEnvironmentAccountConnectionsPaginatorName,\n ListEnvironmentOutputsPaginatorName,\n ListEnvironmentProvisionedResourcesPaginatorName,\n ListEnvironmentTemplateVersionsPaginatorName,\n ListEnvironmentTemplatesPaginatorName,\n ListEnvironmentsPaginatorName,\n ListRepositoriesPaginatorName,\n ListRepositorySyncDefinitionsPaginatorName,\n ListServiceInstanceOutputsPaginatorName,\n ListServiceInstanceProvisionedResourcesPaginatorName,\n ListServiceInstancesFilterByType,\n ListServiceInstancesPaginatorName,\n ListServiceInstancesSortByType,\n ListServicePipelineOutputsPaginatorName,\n ListServicePipelineProvisionedResourcesPaginatorName,\n ListServiceTemplateVersionsPaginatorName,\n ListServiceTemplatesPaginatorName,\n ListServicesPaginatorName,\n ListTagsForResourcePaginatorName,\n ProvisionedResourceEngineType,\n ProvisioningType,\n RepositoryProviderType,\n RepositorySyncStatusType,\n ResourceDeploymentStatusType,\n ResourceSyncStatusType,\n ServiceCreatedWaiterName,\n ServiceDeletedWaiterName,\n ServiceInstanceDeployedWaiterName,\n ServicePipelineDeployedWaiterName,\n ServiceStatusType,\n ServiceTemplateSupportedComponentSourceTypeType,\n ServiceTemplateVersionRegisteredWaiterName,\n ServiceUpdatedWaiterName,\n SortOrderType,\n SyncTypeType,\n TemplateTypeType,\n TemplateVersionStatusType,\n ProtonServiceName,\n ServiceName,\n ResourceServiceName,\n PaginatorName,\n WaiterName,\n RegionName,\n)\n\n\ndef check_value(value: BlockerStatusType) -> bool:\n ...\n```\n\n<a id=\"typed-dictionaries\"></a>\n\n### Typed dictionaries\n\n`mypy_boto3_proton.type_defs` module contains structures and shapes assembled\nto typed dictionaries for additional type checking.\n\n```python\nfrom mypy_boto3_proton.type_defs import (\n AcceptEnvironmentAccountConnectionInputRequestTypeDef,\n EnvironmentAccountConnectionTypeDef,\n RepositoryBranchTypeDef,\n CancelComponentDeploymentInputRequestTypeDef,\n ComponentTypeDef,\n CancelEnvironmentDeploymentInputRequestTypeDef,\n CancelServiceInstanceDeploymentInputRequestTypeDef,\n ServiceInstanceTypeDef,\n CancelServicePipelineDeploymentInputRequestTypeDef,\n ServicePipelineTypeDef,\n CompatibleEnvironmentTemplateInputTypeDef,\n CompatibleEnvironmentTemplateTypeDef,\n ComponentStateTypeDef,\n ComponentSummaryTypeDef,\n ResourceCountsSummaryTypeDef,\n TagTypeDef,\n RepositoryBranchInputTypeDef,\n EnvironmentTemplateTypeDef,\n EnvironmentTemplateVersionTypeDef,\n RepositoryTypeDef,\n CreateServiceSyncConfigInputRequestTypeDef,\n ServiceSyncConfigTypeDef,\n ServiceTemplateTypeDef,\n CreateTemplateSyncConfigInputRequestTypeDef,\n TemplateSyncConfigTypeDef,\n DeleteComponentInputRequestTypeDef,\n DeleteDeploymentInputRequestTypeDef,\n DeleteEnvironmentAccountConnectionInputRequestTypeDef,\n DeleteEnvironmentInputRequestTypeDef,\n DeleteEnvironmentTemplateInputRequestTypeDef,\n DeleteEnvironmentTemplateVersionInputRequestTypeDef,\n DeleteRepositoryInputRequestTypeDef,\n DeleteServiceInputRequestTypeDef,\n DeleteServiceSyncConfigInputRequestTypeDef,\n DeleteServiceTemplateInputRequestTypeDef,\n DeleteServiceTemplateVersionInputRequestTypeDef,\n DeleteTemplateSyncConfigInputRequestTypeDef,\n EnvironmentStateTypeDef,\n ServiceInstanceStateTypeDef,\n ServicePipelineStateTypeDef,\n DeploymentSummaryTypeDef,\n EnvironmentAccountConnectionSummaryTypeDef,\n EnvironmentSummaryTypeDef,\n EnvironmentTemplateFilterTypeDef,\n EnvironmentTemplateSummaryTypeDef,\n EnvironmentTemplateVersionSummaryTypeDef,\n WaiterConfigTypeDef,\n GetComponentInputRequestTypeDef,\n GetDeploymentInputRequestTypeDef,\n GetEnvironmentAccountConnectionInputRequestTypeDef,\n GetEnvironmentInputRequestTypeDef,\n GetEnvironmentTemplateInputRequestTypeDef,\n GetEnvironmentTemplateVersionInputRequestTypeDef,\n GetRepositoryInputRequestTypeDef,\n GetRepositorySyncStatusInputRequestTypeDef,\n GetServiceInputRequestTypeDef,\n GetServiceInstanceInputRequestTypeDef,\n GetServiceInstanceSyncStatusInputRequestTypeDef,\n RevisionTypeDef,\n GetServiceSyncBlockerSummaryInputRequestTypeDef,\n GetServiceSyncConfigInputRequestTypeDef,\n GetServiceTemplateInputRequestTypeDef,\n GetServiceTemplateVersionInputRequestTypeDef,\n GetTemplateSyncConfigInputRequestTypeDef,\n GetTemplateSyncStatusInputRequestTypeDef,\n ListComponentOutputsInputListComponentOutputsPaginateTypeDef,\n ListComponentOutputsInputRequestTypeDef,\n OutputTypeDef,\n ListComponentProvisionedResourcesInputListComponentProvisionedResourcesPaginateTypeDef,\n ListComponentProvisionedResourcesInputRequestTypeDef,\n ProvisionedResourceTypeDef,\n ListComponentsInputListComponentsPaginateTypeDef,\n ListComponentsInputRequestTypeDef,\n ListDeploymentsInputListDeploymentsPaginateTypeDef,\n ListDeploymentsInputRequestTypeDef,\n ListEnvironmentAccountConnectionsInputListEnvironmentAccountConnectionsPaginateTypeDef,\n ListEnvironmentAccountConnectionsInputRequestTypeDef,\n ListEnvironmentOutputsInputListEnvironmentOutputsPaginateTypeDef,\n ListEnvironmentOutputsInputRequestTypeDef,\n ListEnvironmentProvisionedResourcesInputListEnvironmentProvisionedResourcesPaginateTypeDef,\n ListEnvironmentProvisionedResourcesInputRequestTypeDef,\n ListEnvironmentTemplateVersionsInputListEnvironmentTemplateVersionsPaginateTypeDef,\n ListEnvironmentTemplateVersionsInputRequestTypeDef,\n ListEnvironmentTemplatesInputListEnvironmentTemplatesPaginateTypeDef,\n ListEnvironmentTemplatesInputRequestTypeDef,\n ListRepositoriesInputListRepositoriesPaginateTypeDef,\n ListRepositoriesInputRequestTypeDef,\n RepositorySummaryTypeDef,\n ListRepositorySyncDefinitionsInputListRepositorySyncDefinitionsPaginateTypeDef,\n ListRepositorySyncDefinitionsInputRequestTypeDef,\n RepositorySyncDefinitionTypeDef,\n ListServiceInstanceOutputsInputListServiceInstanceOutputsPaginateTypeDef,\n ListServiceInstanceOutputsInputRequestTypeDef,\n ListServiceInstanceProvisionedResourcesInputListServiceInstanceProvisionedResourcesPaginateTypeDef,\n ListServiceInstanceProvisionedResourcesInputRequestTypeDef,\n ListServiceInstancesFilterTypeDef,\n ServiceInstanceSummaryTypeDef,\n ListServicePipelineOutputsInputListServicePipelineOutputsPaginateTypeDef,\n ListServicePipelineOutputsInputRequestTypeDef,\n ListServicePipelineProvisionedResourcesInputListServicePipelineProvisionedResourcesPaginateTypeDef,\n ListServicePipelineProvisionedResourcesInputRequestTypeDef,\n ListServiceTemplateVersionsInputListServiceTemplateVersionsPaginateTypeDef,\n ListServiceTemplateVersionsInputRequestTypeDef,\n ServiceTemplateVersionSummaryTypeDef,\n ListServiceTemplatesInputListServiceTemplatesPaginateTypeDef,\n ListServiceTemplatesInputRequestTypeDef,\n ServiceTemplateSummaryTypeDef,\n ListServicesInputListServicesPaginateTypeDef,\n ListServicesInputRequestTypeDef,\n ServiceSummaryTypeDef,\n ListTagsForResourceInputListTagsForResourcePaginateTypeDef,\n ListTagsForResourceInputRequestTypeDef,\n TagOutputTypeDef,\n PaginatorConfigTypeDef,\n RejectEnvironmentAccountConnectionInputRequestTypeDef,\n RepositorySyncEventTypeDef,\n ResourceSyncEventTypeDef,\n ResponseMetadataTypeDef,\n S3ObjectSourceTypeDef,\n SyncBlockerContextTypeDef,\n UntagResourceInputRequestTypeDef,\n UpdateComponentInputRequestTypeDef,\n UpdateEnvironmentAccountConnectionInputRequestTypeDef,\n UpdateEnvironmentTemplateInputRequestTypeDef,\n UpdateEnvironmentTemplateVersionInputRequestTypeDef,\n UpdateServiceInputRequestTypeDef,\n UpdateServiceInstanceInputRequestTypeDef,\n UpdateServicePipelineInputRequestTypeDef,\n UpdateServiceSyncBlockerInputRequestTypeDef,\n UpdateServiceSyncConfigInputRequestTypeDef,\n UpdateServiceTemplateInputRequestTypeDef,\n UpdateTemplateSyncConfigInputRequestTypeDef,\n AcceptEnvironmentAccountConnectionOutputTypeDef,\n CreateEnvironmentAccountConnectionOutputTypeDef,\n DeleteEnvironmentAccountConnectionOutputTypeDef,\n GetEnvironmentAccountConnectionOutputTypeDef,\n RejectEnvironmentAccountConnectionOutputTypeDef,\n UpdateEnvironmentAccountConnectionOutputTypeDef,\n AccountSettingsTypeDef,\n EnvironmentTypeDef,\n CancelComponentDeploymentOutputTypeDef,\n CreateComponentOutputTypeDef,\n DeleteComponentOutputTypeDef,\n GetComponentOutputTypeDef,\n UpdateComponentOutputTypeDef,\n CancelServiceInstanceDeploymentOutputTypeDef,\n CreateServiceInstanceOutputTypeDef,\n GetServiceInstanceOutputTypeDef,\n UpdateServiceInstanceOutputTypeDef,\n CancelServicePipelineDeploymentOutputTypeDef,\n ServiceTypeDef,\n UpdateServicePipelineOutputTypeDef,\n UpdateServiceTemplateVersionInputRequestTypeDef,\n ServiceTemplateVersionTypeDef,\n ListComponentsOutputTypeDef,\n CountsSummaryTypeDef,\n CreateComponentInputRequestTypeDef,\n CreateEnvironmentAccountConnectionInputRequestTypeDef,\n CreateEnvironmentTemplateInputRequestTypeDef,\n CreateRepositoryInputRequestTypeDef,\n CreateServiceInputRequestTypeDef,\n CreateServiceInstanceInputRequestTypeDef,\n CreateServiceTemplateInputRequestTypeDef,\n TagResourceInputRequestTypeDef,\n CreateEnvironmentInputRequestTypeDef,\n UpdateAccountSettingsInputRequestTypeDef,\n UpdateEnvironmentInputRequestTypeDef,\n CreateEnvironmentTemplateOutputTypeDef,\n DeleteEnvironmentTemplateOutputTypeDef,\n GetEnvironmentTemplateOutputTypeDef,\n UpdateEnvironmentTemplateOutputTypeDef,\n CreateEnvironmentTemplateVersionOutputTypeDef,\n DeleteEnvironmentTemplateVersionOutputTypeDef,\n GetEnvironmentTemplateVersionOutputTypeDef,\n UpdateEnvironmentTemplateVersionOutputTypeDef,\n CreateRepositoryOutputTypeDef,\n DeleteRepositoryOutputTypeDef,\n GetRepositoryOutputTypeDef,\n CreateServiceSyncConfigOutputTypeDef,\n DeleteServiceSyncConfigOutputTypeDef,\n GetServiceSyncConfigOutputTypeDef,\n UpdateServiceSyncConfigOutputTypeDef,\n CreateServiceTemplateOutputTypeDef,\n DeleteServiceTemplateOutputTypeDef,\n GetServiceTemplateOutputTypeDef,\n UpdateServiceTemplateOutputTypeDef,\n CreateTemplateSyncConfigOutputTypeDef,\n DeleteTemplateSyncConfigOutputTypeDef,\n GetTemplateSyncConfigOutputTypeDef,\n UpdateTemplateSyncConfigOutputTypeDef,\n DeploymentStateTypeDef,\n ListDeploymentsOutputTypeDef,\n ListEnvironmentAccountConnectionsOutputTypeDef,\n ListEnvironmentsOutputTypeDef,\n ListEnvironmentsInputListEnvironmentsPaginateTypeDef,\n ListEnvironmentsInputRequestTypeDef,\n ListEnvironmentTemplatesOutputTypeDef,\n ListEnvironmentTemplateVersionsOutputTypeDef,\n GetComponentInputComponentDeletedWaitTypeDef,\n GetComponentInputComponentDeployedWaitTypeDef,\n GetEnvironmentInputEnvironmentDeployedWaitTypeDef,\n GetEnvironmentTemplateVersionInputEnvironmentTemplateVersionRegisteredWaitTypeDef,\n GetServiceInputServiceCreatedWaitTypeDef,\n GetServiceInputServiceDeletedWaitTypeDef,\n GetServiceInputServicePipelineDeployedWaitTypeDef,\n GetServiceInputServiceUpdatedWaitTypeDef,\n GetServiceInstanceInputServiceInstanceDeployedWaitTypeDef,\n GetServiceTemplateVersionInputServiceTemplateVersionRegisteredWaitTypeDef,\n ListComponentOutputsOutputTypeDef,\n ListEnvironmentOutputsOutputTypeDef,\n ListServiceInstanceOutputsOutputTypeDef,\n ListServicePipelineOutputsOutputTypeDef,\n NotifyResourceDeploymentStatusChangeInputRequestTypeDef,\n ListComponentProvisionedResourcesOutputTypeDef,\n ListEnvironmentProvisionedResourcesOutputTypeDef,\n ListServiceInstanceProvisionedResourcesOutputTypeDef,\n ListServicePipelineProvisionedResourcesOutputTypeDef,\n ListRepositoriesOutputTypeDef,\n ListRepositorySyncDefinitionsOutputTypeDef,\n ListServiceInstancesInputListServiceInstancesPaginateTypeDef,\n ListServiceInstancesInputRequestTypeDef,\n ListServiceInstancesOutputTypeDef,\n ListServiceTemplateVersionsOutputTypeDef,\n ListServiceTemplatesOutputTypeDef,\n ListServicesOutputTypeDef,\n ListTagsForResourceOutputTypeDef,\n RepositorySyncAttemptTypeDef,\n ResourceSyncAttemptTypeDef,\n TemplateVersionSourceInputTypeDef,\n SyncBlockerTypeDef,\n GetAccountSettingsOutputTypeDef,\n UpdateAccountSettingsOutputTypeDef,\n CancelEnvironmentDeploymentOutputTypeDef,\n CreateEnvironmentOutputTypeDef,\n DeleteEnvironmentOutputTypeDef,\n GetEnvironmentOutputTypeDef,\n UpdateEnvironmentOutputTypeDef,\n CreateServiceOutputTypeDef,\n DeleteServiceOutputTypeDef,\n GetServiceOutputTypeDef,\n UpdateServiceOutputTypeDef,\n CreateServiceTemplateVersionOutputTypeDef,\n DeleteServiceTemplateVersionOutputTypeDef,\n GetServiceTemplateVersionOutputTypeDef,\n UpdateServiceTemplateVersionOutputTypeDef,\n GetResourcesSummaryOutputTypeDef,\n DeploymentTypeDef,\n GetRepositorySyncStatusOutputTypeDef,\n GetServiceInstanceSyncStatusOutputTypeDef,\n GetTemplateSyncStatusOutputTypeDef,\n CreateEnvironmentTemplateVersionInputRequestTypeDef,\n CreateServiceTemplateVersionInputRequestTypeDef,\n ServiceSyncBlockerSummaryTypeDef,\n UpdateServiceSyncBlockerOutputTypeDef,\n DeleteDeploymentOutputTypeDef,\n GetDeploymentOutputTypeDef,\n GetServiceSyncBlockerSummaryOutputTypeDef,\n)\n\n\ndef get_structure() -> AcceptEnvironmentAccountConnectionInputRequestTypeDef:\n return {...}\n```\n\n<a id=\"how-it-works\"></a>\n\n## How it works\n\nFully automated\n[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully\ngenerates type annotations for each service, patiently waiting for `boto3`\nupdates. It delivers drop-in type annotations for you and makes sure that:\n\n- All available `boto3` services are covered.\n- Each public class and method of every `boto3` service gets valid type\n annotations extracted from `botocore` schemas.\n- Type annotations include up-to-date documentation.\n- Link to documentation is provided for every method.\n- Code is processed by [black](https://github.com/psf/black) and\n [isort](https://github.com/PyCQA/isort) for readability.\n\n<a id=\"what's-new\"></a>\n\n## What's new\n\n<a id=\"implemented-features\"></a>\n\n### Implemented features\n\n- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`\n libraries\n- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`\n compatibility\n- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type\n annotations for each service\n- Generated `TypeDefs` for each service\n- Generated `Literals` for each service\n- Auto discovery of types for `boto3.client` and `boto3.resource` calls\n- Auto discovery of types for `session.client` and `session.resource` calls\n- Auto discovery of types for `client.get_waiter` and `client.get_paginator`\n calls\n- Auto discovery of types for `ServiceResource` and `Resource` collections\n- Auto discovery of types for `aiobotocore.Session.create_client` calls\n\n<a id=\"latest-changes\"></a>\n\n### Latest changes\n\nBuilder changelog can be found in\n[Releases](https://github.com/youtype/mypy_boto3_builder/releases).\n\n<a id=\"versioning\"></a>\n\n## Versioning\n\n`mypy-boto3-proton` version is the same as related `boto3` version and follows\n[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.\n\n<a id=\"thank-you\"></a>\n\n## Thank you\n\n- [Allie Fitter](https://github.com/alliefitter) for\n [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),\n this package is based on top of his work\n- [black](https://github.com/psf/black) developers for an awesome formatting\n tool\n- [Timothy Edmund Crosley](https://github.com/timothycrosley) for\n [isort](https://github.com/PyCQA/isort) and how flexible it is\n- [mypy](https://github.com/python/mypy) developers for doing all dirty work\n for us\n- [pyright](https://github.com/microsoft/pyright) team for the new era of typed\n Python\n\n<a id=\"documentation\"></a>\n\n## Documentation\n\nAll services type annotations can be found in\n[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_proton/)\n\n<a id=\"support-and-contributing\"></a>\n\n## Support and contributing\n\nThis package is auto-generated. Please reports any bugs or request new features\nin [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)\nrepository.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Type annotations for boto3.Proton 1.28.3 service generated with mypy-boto3-builder 7.15.0",
"version": "1.28.3.post2",
"project_urls": {
"Documentation": "https://youtype.github.io/boto3_stubs_docs/mypy_boto3_proton/",
"Homepage": "https://github.com/youtype/mypy_boto3_builder",
"Source": "https://github.com/youtype/mypy_boto3_builder",
"Tracker": "https://github.com/youtype/mypy_boto3_builder/issues"
},
"split_keywords": [
"boto3",
"proton",
"type-annotations",
"boto3-stubs",
"mypy",
"typeshed",
"autocomplete"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14a7a58e2ba1af7eb3a3a523a3bf8b06fac7dd1bdbbd3e2e053b07c54aaa4d1d",
"md5": "48ded9b20e75fdf03dd71b56beb35936",
"sha256": "06e707d8389d318321549e015c4faea3badc0bebb944c177c4bb548e9c9840f6"
},
"downloads": -1,
"filename": "mypy_boto3_proton-1.28.3.post2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "48ded9b20e75fdf03dd71b56beb35936",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 55422,
"upload_time": "2023-07-15T06:38:39",
"upload_time_iso_8601": "2023-07-15T06:38:39.607969Z",
"url": "https://files.pythonhosted.org/packages/14/a7/a58e2ba1af7eb3a3a523a3bf8b06fac7dd1bdbbd3e2e053b07c54aaa4d1d/mypy_boto3_proton-1.28.3.post2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9be85a2531247a6e5ea71af8a8b1f47c9cbf96834d3940c9c00c7c35261178f2",
"md5": "8cb510534ec2d36b0e2089251215e20b",
"sha256": "9677021c440e09140a92dad613e31f9883a9f9b7c4845145d35473c9048b4886"
},
"downloads": -1,
"filename": "mypy-boto3-proton-1.28.3.post2.tar.gz",
"has_sig": false,
"md5_digest": "8cb510534ec2d36b0e2089251215e20b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 50233,
"upload_time": "2023-07-15T06:38:55",
"upload_time_iso_8601": "2023-07-15T06:38:55.653736Z",
"url": "https://files.pythonhosted.org/packages/9b/e8/5a2531247a6e5ea71af8a8b1f47c9cbf96834d3940c9c00c7c35261178f2/mypy-boto3-proton-1.28.3.post2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-15 06:38:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "youtype",
"github_project": "mypy_boto3_builder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mypy-boto3-proton"
}