Amplify module#
Index > Amplify
Auto-generated documentation for Amplify type annotations stubs module mypy-boto3-amplify.
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 Amplify
.
From PyPI with pip#
Install boto3-stubs
for Amplify
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[amplify]'
# 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[amplify]'
# standalone installation
python -m pip install mypy-boto3-amplify
How to uninstall#
python -m pip uninstall -y mypy-boto3-amplify
Usage#
Code samples can be found in Examples.
AmplifyClient#
Type annotations and code completion for boto3.client("amplify")
as AmplifyClient
boto3 documentation
# AmplifyClient usage example
from boto3.session import Session
from mypy_boto3_amplify.client import AmplifyClient
def get_client() -> AmplifyClient:
return Session().client("amplify")
Paginators#
Type annotations and code completion for paginators
from boto3.client("amplify").get_paginator("...")
.
# ListAppsPaginator usage example
from boto3.session import Session
from mypy_boto3_amplify.paginator import ListAppsPaginator
def get_list_apps_paginator() -> ListAppsPaginator:
return Session().client("amplify").get_paginator("list_apps"))
Literals#
Type annotations for literals used in methods and schemas.
# DomainStatusType usage example
from mypy_boto3_amplify.literals import DomainStatusType
def get_value() -> DomainStatusType:
return "AVAILABLE"
- DomainStatusType
- JobStatusType
- JobTypeType
- ListAppsPaginatorName
- ListBranchesPaginatorName
- ListDomainAssociationsPaginatorName
- ListJobsPaginatorName
- PlatformType
- RepositoryCloneMethodType
- StageType
- AmplifyServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AutoBranchCreationConfigTypeDef usage example
from mypy_boto3_amplify.type_defs import AutoBranchCreationConfigTypeDef
def get_value() -> AutoBranchCreationConfigTypeDef:
return {
"stage": ...,
}
- AutoBranchCreationConfigTypeDef
- CustomRuleTypeDef
- ProductionBranchTypeDef
- ArtifactTypeDef
- BackendEnvironmentTypeDef
- BranchTypeDef
- ResponseMetadataTypeDef
- CreateBackendEnvironmentRequestRequestTypeDef
- CreateBranchRequestRequestTypeDef
- CreateDeploymentRequestRequestTypeDef
- SubDomainSettingTypeDef
- CreateWebhookRequestRequestTypeDef
- WebhookTypeDef
- DeleteAppRequestRequestTypeDef
- DeleteBackendEnvironmentRequestRequestTypeDef
- DeleteBranchRequestRequestTypeDef
- DeleteDomainAssociationRequestRequestTypeDef
- DeleteJobRequestRequestTypeDef
- JobSummaryTypeDef
- DeleteWebhookRequestRequestTypeDef
- GenerateAccessLogsRequestRequestTypeDef
- GetAppRequestRequestTypeDef
- GetArtifactUrlRequestRequestTypeDef
- GetBackendEnvironmentRequestRequestTypeDef
- GetBranchRequestRequestTypeDef
- GetDomainAssociationRequestRequestTypeDef
- GetJobRequestRequestTypeDef
- GetWebhookRequestRequestTypeDef
- StepTypeDef
- PaginatorConfigTypeDef
- ListAppsRequestRequestTypeDef
- ListArtifactsRequestRequestTypeDef
- ListBackendEnvironmentsRequestRequestTypeDef
- ListBranchesRequestRequestTypeDef
- ListDomainAssociationsRequestRequestTypeDef
- ListJobsRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListWebhooksRequestRequestTypeDef
- StartDeploymentRequestRequestTypeDef
- StartJobRequestRequestTypeDef
- StopJobRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateBranchRequestRequestTypeDef
- UpdateWebhookRequestRequestTypeDef
- CreateAppRequestRequestTypeDef
- UpdateAppRequestRequestTypeDef
- AppTypeDef
- CreateBackendEnvironmentResultTypeDef
- CreateBranchResultTypeDef
- CreateDeploymentResultTypeDef
- DeleteBackendEnvironmentResultTypeDef
- DeleteBranchResultTypeDef
- GenerateAccessLogsResultTypeDef
- GetArtifactUrlResultTypeDef
- GetBackendEnvironmentResultTypeDef
- GetBranchResultTypeDef
- ListArtifactsResultTypeDef
- ListBackendEnvironmentsResultTypeDef
- ListBranchesResultTypeDef
- ListTagsForResourceResponseTypeDef
- UpdateBranchResultTypeDef
- CreateDomainAssociationRequestRequestTypeDef
- SubDomainTypeDef
- UpdateDomainAssociationRequestRequestTypeDef
- CreateWebhookResultTypeDef
- DeleteWebhookResultTypeDef
- GetWebhookResultTypeDef
- ListWebhooksResultTypeDef
- UpdateWebhookResultTypeDef
- DeleteJobResultTypeDef
- ListJobsResultTypeDef
- StartDeploymentResultTypeDef
- StartJobResultTypeDef
- StopJobResultTypeDef
- JobTypeDef
- ListAppsRequestListAppsPaginateTypeDef
- ListBranchesRequestListBranchesPaginateTypeDef
- ListDomainAssociationsRequestListDomainAssociationsPaginateTypeDef
- ListJobsRequestListJobsPaginateTypeDef
- CreateAppResultTypeDef
- DeleteAppResultTypeDef
- GetAppResultTypeDef
- ListAppsResultTypeDef
- UpdateAppResultTypeDef
- DomainAssociationTypeDef
- GetJobResultTypeDef
- CreateDomainAssociationResultTypeDef
- DeleteDomainAssociationResultTypeDef
- GetDomainAssociationResultTypeDef
- ListDomainAssociationsResultTypeDef
- UpdateDomainAssociationResultTypeDef