Proton module#
Index > Proton
Auto-generated documentation for Proton type annotations stubs module mypy-boto3-proton.
How to install#
VSCode extension#
Add AWS Boto3
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.
# 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#
python -m pip uninstall -y mypy-boto3-proton
Usage#
Code samples can be found in Examples.
ProtonClient#
Type annotations and code completion for boto3.client("proton")
as ProtonClient
boto3 documentation
# ProtonClient usage example
from boto3.session import Session
from mypy_boto3_proton.client import ProtonClient
def get_client() -> ProtonClient:
return Session().client("proton")
Paginators#
Type annotations and code completion for paginators
from boto3.client("proton").get_paginator("...")
.
# ListComponentOutputsPaginator usage example
from boto3.session import Session
from mypy_boto3_proton.paginator import ListComponentOutputsPaginator
def get_list_component_outputs_paginator() -> ListComponentOutputsPaginator:
return Session().client("proton").get_paginator("list_component_outputs"))
- ListComponentOutputsPaginator
- ListComponentProvisionedResourcesPaginator
- ListComponentsPaginator
- ListEnvironmentAccountConnectionsPaginator
- ListEnvironmentOutputsPaginator
- ListEnvironmentProvisionedResourcesPaginator
- ListEnvironmentTemplateVersionsPaginator
- ListEnvironmentTemplatesPaginator
- ListEnvironmentsPaginator
- ListRepositoriesPaginator
- ListRepositorySyncDefinitionsPaginator
- ListServiceInstanceOutputsPaginator
- ListServiceInstanceProvisionedResourcesPaginator
- ListServiceInstancesPaginator
- ListServicePipelineOutputsPaginator
- ListServicePipelineProvisionedResourcesPaginator
- ListServiceTemplateVersionsPaginator
- ListServiceTemplatesPaginator
- ListServicesPaginator
- ListTagsForResourcePaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("proton").get_waiter("...")
.
# ComponentDeletedWaiter usage example
from boto3.session import Session
from mypy_boto3_proton.waiter import ComponentDeletedWaiter
def get_component_deleted_waiter() -> ComponentDeletedWaiter:
return Session().client("proton").get_waiter("component_deleted")
- ComponentDeletedWaiter
- ComponentDeployedWaiter
- EnvironmentDeployedWaiter
- EnvironmentTemplateVersionRegisteredWaiter
- ServiceCreatedWaiter
- ServiceDeletedWaiter
- ServiceInstanceDeployedWaiter
- ServicePipelineDeployedWaiter
- ServiceTemplateVersionRegisteredWaiter
- ServiceUpdatedWaiter
Literals#
Type annotations for literals used in methods and schemas.
# BlockerStatusType usage example
from mypy_boto3_proton.literals import BlockerStatusType
def get_value() -> BlockerStatusType:
return "ACTIVE"
- 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
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AcceptEnvironmentAccountConnectionInputRequestTypeDef usage example
from mypy_boto3_proton.type_defs import AcceptEnvironmentAccountConnectionInputRequestTypeDef
def get_value() -> AcceptEnvironmentAccountConnectionInputRequestTypeDef:
return {
"id": ...,
}
- AcceptEnvironmentAccountConnectionInputRequestTypeDef
- EnvironmentAccountConnectionTypeDef
- 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
- ListComponentOutputsInputListComponentOutputsPaginateTypeDef
- ListComponentOutputsInputRequestTypeDef
- OutputTypeDef
- ListComponentProvisionedResourcesInputListComponentProvisionedResourcesPaginateTypeDef
- ListComponentProvisionedResourcesInputRequestTypeDef
- ProvisionedResourceTypeDef
- ListComponentsInputListComponentsPaginateTypeDef
- ListComponentsInputRequestTypeDef
- 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
- 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
- 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
- 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
- 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