AmplifyBackend module#
Index > AmplifyBackend
Auto-generated documentation for AmplifyBackend type annotations stubs module types-boto3-amplifybackend.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
AmplifyBackend
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and AmplifyBackend
.
From PyPI with pip#
Install types-boto3
for AmplifyBackend
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[amplifybackend]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[amplifybackend]'
# standalone installation
python -m pip install types-boto3-amplifybackend
How to uninstall#
python -m pip uninstall -y types-boto3-amplifybackend
Usage#
Code samples can be found in Examples.
AmplifyBackendClient#
Type annotations and code completion for boto3.client("amplifybackend")
as AmplifyBackendClient
boto3 documentation
# AmplifyBackendClient usage example
from boto3.session import Session
from types_boto3_amplifybackend.client import AmplifyBackendClient
def get_client() -> AmplifyBackendClient:
return Session().client("amplifybackend")
Paginators#
Type annotations and code completion for paginators
from boto3.client("amplifybackend").get_paginator("...")
.
# ListBackendJobsPaginator usage example
from boto3.session import Session
from types_boto3_amplifybackend.paginator import ListBackendJobsPaginator
def get_list_backend_jobs_paginator() -> ListBackendJobsPaginator:
return Session().client("amplifybackend").get_paginator("list_backend_jobs"))
Literals#
Type annotations for literals used in methods and schema.
# AdditionalConstraintsElementType usage example
from types_boto3_amplifybackend.literals import AdditionalConstraintsElementType
def get_value() -> AdditionalConstraintsElementType:
return "REQUIRE_DIGIT"
- AdditionalConstraintsElementType
- AuthResourcesType
- AuthenticatedElementType
- DeliveryMethodType
- ListBackendJobsPaginatorName
- MFAModeType
- MfaTypesElementType
- ModeType
- OAuthGrantTypeType
- OAuthScopesElementType
- RequiredSignUpAttributesElementType
- ResolutionStrategyType
- ServiceNameType
- ServiceType
- SignInMethodType
- StatusType
- UnAuthenticatedElementType
- AmplifyBackendServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- BackendAPIAppSyncAuthSettingsTypeDef
- BackendAPIConflictResolutionTypeDef
- BackendAuthAppleProviderConfigTypeDef
- BackendAuthSocialProviderConfigTypeDef
- BackendJobRespObjTypeDef
- BackendStoragePermissionsOutputTypeDef
- BackendStoragePermissionsTypeDef
- CloneBackendRequestTypeDef
- ResponseMetadataTypeDef
- EmailSettingsTypeDef
- SmsSettingsTypeDef
- CreateBackendAuthIdentityPoolConfigTypeDef
- SettingsOutputTypeDef
- SettingsTypeDef
- CreateBackendAuthPasswordPolicyConfigOutputTypeDef
- CreateBackendAuthPasswordPolicyConfigTypeDef
- CreateBackendConfigRequestTypeDef
- CreateBackendRequestTypeDef
- CreateTokenRequestTypeDef
- DeleteBackendAuthRequestTypeDef
- DeleteBackendRequestTypeDef
- DeleteBackendStorageRequestTypeDef
- DeleteTokenRequestTypeDef
- GenerateBackendAPIModelsRequestTypeDef
- GetBackendAPIModelsRequestTypeDef
- GetBackendAuthRequestTypeDef
- GetBackendJobRequestTypeDef
- GetBackendRequestTypeDef
- GetBackendStorageRequestTypeDef
- GetTokenRequestTypeDef
- ImportBackendAuthRequestTypeDef
- ImportBackendStorageRequestTypeDef
- PaginatorConfigTypeDef
- ListBackendJobsRequestTypeDef
- ListS3BucketsRequestTypeDef
- S3BucketInfoTypeDef
- LoginAuthConfigReqObjTypeDef
- RemoveAllBackendsRequestTypeDef
- RemoveBackendConfigRequestTypeDef
- UpdateBackendAuthIdentityPoolConfigTypeDef
- UpdateBackendAuthPasswordPolicyConfigTypeDef
- UpdateBackendJobRequestTypeDef
- BackendAPIAuthTypeTypeDef
- SocialProviderSettingsTypeDef
- GetBackendStorageResourceConfigTypeDef
- BackendStoragePermissionsUnionTypeDef
- CloneBackendResponseTypeDef
- CreateBackendAPIResponseTypeDef
- CreateBackendAuthResponseTypeDef
- CreateBackendConfigResponseTypeDef
- CreateBackendResponseTypeDef
- CreateBackendStorageResponseTypeDef
- CreateTokenResponseTypeDef
- DeleteBackendAPIResponseTypeDef
- DeleteBackendAuthResponseTypeDef
- DeleteBackendResponseTypeDef
- DeleteBackendStorageResponseTypeDef
- DeleteTokenResponseTypeDef
- GenerateBackendAPIModelsResponseTypeDef
- GetBackendAPIModelsResponseTypeDef
- GetBackendJobResponseTypeDef
- GetBackendResponseTypeDef
- GetTokenResponseTypeDef
- ImportBackendAuthResponseTypeDef
- ImportBackendStorageResponseTypeDef
- ListBackendJobsResponseTypeDef
- RemoveAllBackendsResponseTypeDef
- RemoveBackendConfigResponseTypeDef
- UpdateBackendAPIResponseTypeDef
- UpdateBackendAuthResponseTypeDef
- UpdateBackendJobResponseTypeDef
- UpdateBackendStorageResponseTypeDef
- CreateBackendAuthForgotPasswordConfigTypeDef
- CreateBackendAuthVerificationMessageConfigTypeDef
- UpdateBackendAuthForgotPasswordConfigTypeDef
- UpdateBackendAuthVerificationMessageConfigTypeDef
- CreateBackendAuthMFAConfigOutputTypeDef
- CreateBackendAuthMFAConfigTypeDef
- SettingsUnionTypeDef
- ListBackendJobsRequestPaginateTypeDef
- ListS3BucketsResponseTypeDef
- UpdateBackendConfigRequestTypeDef
- UpdateBackendConfigResponseTypeDef
- BackendAPIResourceConfigOutputTypeDef
- BackendAPIResourceConfigTypeDef
- CreateBackendAuthOAuthConfigOutputTypeDef
- CreateBackendAuthOAuthConfigTypeDef
- UpdateBackendAuthOAuthConfigTypeDef
- GetBackendStorageResponseTypeDef
- CreateBackendStorageResourceConfigTypeDef
- UpdateBackendStorageResourceConfigTypeDef
- UpdateBackendAuthMFAConfigTypeDef
- GetBackendAPIResponseTypeDef
- BackendAPIResourceConfigUnionTypeDef
- CreateBackendAuthUserPoolConfigOutputTypeDef
- CreateBackendAuthUserPoolConfigTypeDef
- CreateBackendStorageRequestTypeDef
- UpdateBackendStorageRequestTypeDef
- UpdateBackendAuthUserPoolConfigTypeDef
- CreateBackendAPIRequestTypeDef
- DeleteBackendAPIRequestTypeDef
- GetBackendAPIRequestTypeDef
- UpdateBackendAPIRequestTypeDef
- CreateBackendAuthResourceConfigOutputTypeDef
- CreateBackendAuthResourceConfigTypeDef
- UpdateBackendAuthResourceConfigTypeDef
- GetBackendAuthResponseTypeDef
- CreateBackendAuthResourceConfigUnionTypeDef
- UpdateBackendAuthRequestTypeDef
- CreateBackendAuthRequestTypeDef