Type definitions#
Index > AmplifyBackend > Type definitions
Auto-generated documentation for AmplifyBackend type annotations stubs module mypy-boto3-amplifybackend.
BackendStoragePermissionsUnionTypeDef#
# BackendStoragePermissionsUnionTypeDef Union usage example
from mypy_boto3_amplifybackend.type_defs import BackendStoragePermissionsUnionTypeDef
def get_value() -> BackendStoragePermissionsUnionTypeDef:
return ...
# BackendStoragePermissionsUnionTypeDef definition
BackendStoragePermissionsUnionTypeDef = Union[
BackendStoragePermissionsTypeDef, # (1)
BackendStoragePermissionsOutputTypeDef, # (2)
]
SettingsUnionTypeDef#
# SettingsUnionTypeDef Union usage example
from mypy_boto3_amplifybackend.type_defs import SettingsUnionTypeDef
def get_value() -> SettingsUnionTypeDef:
return ...
# SettingsUnionTypeDef definition
SettingsUnionTypeDef = Union[
SettingsTypeDef, # (1)
SettingsOutputTypeDef, # (2)
]
- See SettingsTypeDef
- See SettingsOutputTypeDef
BackendAPIResourceConfigUnionTypeDef#
# BackendAPIResourceConfigUnionTypeDef Union usage example
from mypy_boto3_amplifybackend.type_defs import BackendAPIResourceConfigUnionTypeDef
def get_value() -> BackendAPIResourceConfigUnionTypeDef:
return ...
# BackendAPIResourceConfigUnionTypeDef definition
BackendAPIResourceConfigUnionTypeDef = Union[
BackendAPIResourceConfigTypeDef, # (1)
BackendAPIResourceConfigOutputTypeDef, # (2)
]
CreateBackendAuthResourceConfigUnionTypeDef#
# CreateBackendAuthResourceConfigUnionTypeDef Union usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthResourceConfigUnionTypeDef
def get_value() -> CreateBackendAuthResourceConfigUnionTypeDef:
return ...
# CreateBackendAuthResourceConfigUnionTypeDef definition
CreateBackendAuthResourceConfigUnionTypeDef = Union[
CreateBackendAuthResourceConfigTypeDef, # (1)
CreateBackendAuthResourceConfigOutputTypeDef, # (2)
]
BackendAPIAppSyncAuthSettingsTypeDef#
# BackendAPIAppSyncAuthSettingsTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import BackendAPIAppSyncAuthSettingsTypeDef
def get_value() -> BackendAPIAppSyncAuthSettingsTypeDef:
return {
"CognitoUserPoolId": ...,
}
# BackendAPIAppSyncAuthSettingsTypeDef definition
class BackendAPIAppSyncAuthSettingsTypeDef(TypedDict):
CognitoUserPoolId: NotRequired[str],
Description: NotRequired[str],
ExpirationTime: NotRequired[float],
OpenIDAuthTTL: NotRequired[str],
OpenIDClientId: NotRequired[str],
OpenIDIatTTL: NotRequired[str],
OpenIDIssueURL: NotRequired[str],
OpenIDProviderName: NotRequired[str],
BackendAPIConflictResolutionTypeDef#
# BackendAPIConflictResolutionTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import BackendAPIConflictResolutionTypeDef
def get_value() -> BackendAPIConflictResolutionTypeDef:
return {
"ResolutionStrategy": ...,
}
# BackendAPIConflictResolutionTypeDef definition
class BackendAPIConflictResolutionTypeDef(TypedDict):
ResolutionStrategy: NotRequired[ResolutionStrategyType], # (1)
BackendAuthAppleProviderConfigTypeDef#
# BackendAuthAppleProviderConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import BackendAuthAppleProviderConfigTypeDef
def get_value() -> BackendAuthAppleProviderConfigTypeDef:
return {
"ClientId": ...,
}
# BackendAuthAppleProviderConfigTypeDef definition
class BackendAuthAppleProviderConfigTypeDef(TypedDict):
ClientId: NotRequired[str],
KeyId: NotRequired[str],
PrivateKey: NotRequired[str],
TeamId: NotRequired[str],
BackendAuthSocialProviderConfigTypeDef#
# BackendAuthSocialProviderConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import BackendAuthSocialProviderConfigTypeDef
def get_value() -> BackendAuthSocialProviderConfigTypeDef:
return {
"ClientId": ...,
}
# BackendAuthSocialProviderConfigTypeDef definition
class BackendAuthSocialProviderConfigTypeDef(TypedDict):
ClientId: NotRequired[str],
ClientSecret: NotRequired[str],
BackendJobRespObjTypeDef#
# BackendJobRespObjTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import BackendJobRespObjTypeDef
def get_value() -> BackendJobRespObjTypeDef:
return {
"AppId": ...,
}
# BackendJobRespObjTypeDef definition
class BackendJobRespObjTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
CreateTime: NotRequired[str],
Error: NotRequired[str],
JobId: NotRequired[str],
Operation: NotRequired[str],
Status: NotRequired[str],
UpdateTime: NotRequired[str],
BackendStoragePermissionsOutputTypeDef#
# BackendStoragePermissionsOutputTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import BackendStoragePermissionsOutputTypeDef
def get_value() -> BackendStoragePermissionsOutputTypeDef:
return {
"Authenticated": ...,
}
# BackendStoragePermissionsOutputTypeDef definition
class BackendStoragePermissionsOutputTypeDef(TypedDict):
Authenticated: List[AuthenticatedElementType], # (1)
UnAuthenticated: NotRequired[List[UnAuthenticatedElementType]], # (2)
BackendStoragePermissionsTypeDef#
# BackendStoragePermissionsTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import BackendStoragePermissionsTypeDef
def get_value() -> BackendStoragePermissionsTypeDef:
return {
"Authenticated": ...,
}
# BackendStoragePermissionsTypeDef definition
class BackendStoragePermissionsTypeDef(TypedDict):
Authenticated: Sequence[AuthenticatedElementType], # (1)
UnAuthenticated: NotRequired[Sequence[UnAuthenticatedElementType]], # (2)
CloneBackendRequestTypeDef#
# CloneBackendRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CloneBackendRequestTypeDef
def get_value() -> CloneBackendRequestTypeDef:
return {
"AppId": ...,
}
# CloneBackendRequestTypeDef definition
class CloneBackendRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
TargetEnvironmentName: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
EmailSettingsTypeDef#
# EmailSettingsTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import EmailSettingsTypeDef
def get_value() -> EmailSettingsTypeDef:
return {
"EmailMessage": ...,
}
# EmailSettingsTypeDef definition
class EmailSettingsTypeDef(TypedDict):
EmailMessage: NotRequired[str],
EmailSubject: NotRequired[str],
SmsSettingsTypeDef#
# SmsSettingsTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import SmsSettingsTypeDef
def get_value() -> SmsSettingsTypeDef:
return {
"SmsMessage": ...,
}
# SmsSettingsTypeDef definition
class SmsSettingsTypeDef(TypedDict):
SmsMessage: NotRequired[str],
CreateBackendAuthIdentityPoolConfigTypeDef#
# CreateBackendAuthIdentityPoolConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthIdentityPoolConfigTypeDef
def get_value() -> CreateBackendAuthIdentityPoolConfigTypeDef:
return {
"IdentityPoolName": ...,
}
# CreateBackendAuthIdentityPoolConfigTypeDef definition
class CreateBackendAuthIdentityPoolConfigTypeDef(TypedDict):
IdentityPoolName: str,
UnauthenticatedLogin: bool,
SettingsOutputTypeDef#
# SettingsOutputTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import SettingsOutputTypeDef
def get_value() -> SettingsOutputTypeDef:
return {
"MfaTypes": ...,
}
# SettingsOutputTypeDef definition
class SettingsOutputTypeDef(TypedDict):
MfaTypes: NotRequired[List[MfaTypesElementType]], # (1)
SmsMessage: NotRequired[str],
SettingsTypeDef#
# SettingsTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import SettingsTypeDef
def get_value() -> SettingsTypeDef:
return {
"MfaTypes": ...,
}
# SettingsTypeDef definition
class SettingsTypeDef(TypedDict):
MfaTypes: NotRequired[Sequence[MfaTypesElementType]], # (1)
SmsMessage: NotRequired[str],
CreateBackendAuthPasswordPolicyConfigOutputTypeDef#
# CreateBackendAuthPasswordPolicyConfigOutputTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthPasswordPolicyConfigOutputTypeDef
def get_value() -> CreateBackendAuthPasswordPolicyConfigOutputTypeDef:
return {
"AdditionalConstraints": ...,
}
# CreateBackendAuthPasswordPolicyConfigOutputTypeDef definition
class CreateBackendAuthPasswordPolicyConfigOutputTypeDef(TypedDict):
MinimumLength: float,
AdditionalConstraints: NotRequired[List[AdditionalConstraintsElementType]], # (1)
CreateBackendAuthPasswordPolicyConfigTypeDef#
# CreateBackendAuthPasswordPolicyConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthPasswordPolicyConfigTypeDef
def get_value() -> CreateBackendAuthPasswordPolicyConfigTypeDef:
return {
"AdditionalConstraints": ...,
}
# CreateBackendAuthPasswordPolicyConfigTypeDef definition
class CreateBackendAuthPasswordPolicyConfigTypeDef(TypedDict):
MinimumLength: float,
AdditionalConstraints: NotRequired[Sequence[AdditionalConstraintsElementType]], # (1)
CreateBackendConfigRequestTypeDef#
# CreateBackendConfigRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendConfigRequestTypeDef
def get_value() -> CreateBackendConfigRequestTypeDef:
return {
"AppId": ...,
}
# CreateBackendConfigRequestTypeDef definition
class CreateBackendConfigRequestTypeDef(TypedDict):
AppId: str,
BackendManagerAppId: NotRequired[str],
CreateBackendRequestTypeDef#
# CreateBackendRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendRequestTypeDef
def get_value() -> CreateBackendRequestTypeDef:
return {
"AppId": ...,
}
# CreateBackendRequestTypeDef definition
class CreateBackendRequestTypeDef(TypedDict):
AppId: str,
AppName: str,
BackendEnvironmentName: str,
ResourceConfig: NotRequired[Mapping[str, Any]],
ResourceName: NotRequired[str],
CreateTokenRequestTypeDef#
# CreateTokenRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateTokenRequestTypeDef
def get_value() -> CreateTokenRequestTypeDef:
return {
"AppId": ...,
}
# CreateTokenRequestTypeDef definition
class CreateTokenRequestTypeDef(TypedDict):
AppId: str,
DeleteBackendAuthRequestTypeDef#
# DeleteBackendAuthRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendAuthRequestTypeDef
def get_value() -> DeleteBackendAuthRequestTypeDef:
return {
"AppId": ...,
}
# DeleteBackendAuthRequestTypeDef definition
class DeleteBackendAuthRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
DeleteBackendRequestTypeDef#
# DeleteBackendRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendRequestTypeDef
def get_value() -> DeleteBackendRequestTypeDef:
return {
"AppId": ...,
}
# DeleteBackendRequestTypeDef definition
class DeleteBackendRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
DeleteBackendStorageRequestTypeDef#
# DeleteBackendStorageRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendStorageRequestTypeDef
def get_value() -> DeleteBackendStorageRequestTypeDef:
return {
"AppId": ...,
}
# DeleteBackendStorageRequestTypeDef definition
class DeleteBackendStorageRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
ServiceName: ServiceNameType, # (1)
- See ServiceNameType
DeleteTokenRequestTypeDef#
# DeleteTokenRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import DeleteTokenRequestTypeDef
def get_value() -> DeleteTokenRequestTypeDef:
return {
"AppId": ...,
}
# DeleteTokenRequestTypeDef definition
class DeleteTokenRequestTypeDef(TypedDict):
AppId: str,
SessionId: str,
GenerateBackendAPIModelsRequestTypeDef#
# GenerateBackendAPIModelsRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GenerateBackendAPIModelsRequestTypeDef
def get_value() -> GenerateBackendAPIModelsRequestTypeDef:
return {
"AppId": ...,
}
# GenerateBackendAPIModelsRequestTypeDef definition
class GenerateBackendAPIModelsRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
GetBackendAPIModelsRequestTypeDef#
# GetBackendAPIModelsRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetBackendAPIModelsRequestTypeDef
def get_value() -> GetBackendAPIModelsRequestTypeDef:
return {
"AppId": ...,
}
# GetBackendAPIModelsRequestTypeDef definition
class GetBackendAPIModelsRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
GetBackendAuthRequestTypeDef#
# GetBackendAuthRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetBackendAuthRequestTypeDef
def get_value() -> GetBackendAuthRequestTypeDef:
return {
"AppId": ...,
}
# GetBackendAuthRequestTypeDef definition
class GetBackendAuthRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
GetBackendJobRequestTypeDef#
# GetBackendJobRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetBackendJobRequestTypeDef
def get_value() -> GetBackendJobRequestTypeDef:
return {
"AppId": ...,
}
# GetBackendJobRequestTypeDef definition
class GetBackendJobRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: str,
GetBackendRequestTypeDef#
# GetBackendRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetBackendRequestTypeDef
def get_value() -> GetBackendRequestTypeDef:
return {
"AppId": ...,
}
# GetBackendRequestTypeDef definition
class GetBackendRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: NotRequired[str],
GetBackendStorageRequestTypeDef#
# GetBackendStorageRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetBackendStorageRequestTypeDef
def get_value() -> GetBackendStorageRequestTypeDef:
return {
"AppId": ...,
}
# GetBackendStorageRequestTypeDef definition
class GetBackendStorageRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
GetTokenRequestTypeDef#
# GetTokenRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetTokenRequestTypeDef
def get_value() -> GetTokenRequestTypeDef:
return {
"AppId": ...,
}
# GetTokenRequestTypeDef definition
class GetTokenRequestTypeDef(TypedDict):
AppId: str,
SessionId: str,
ImportBackendAuthRequestTypeDef#
# ImportBackendAuthRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import ImportBackendAuthRequestTypeDef
def get_value() -> ImportBackendAuthRequestTypeDef:
return {
"AppId": ...,
}
# ImportBackendAuthRequestTypeDef definition
class ImportBackendAuthRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
NativeClientId: str,
UserPoolId: str,
WebClientId: str,
IdentityPoolId: NotRequired[str],
ImportBackendStorageRequestTypeDef#
# ImportBackendStorageRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import ImportBackendStorageRequestTypeDef
def get_value() -> ImportBackendStorageRequestTypeDef:
return {
"AppId": ...,
}
# ImportBackendStorageRequestTypeDef definition
class ImportBackendStorageRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ServiceName: ServiceNameType, # (1)
BucketName: NotRequired[str],
- See ServiceNameType
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListBackendJobsRequestTypeDef#
# ListBackendJobsRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import ListBackendJobsRequestTypeDef
def get_value() -> ListBackendJobsRequestTypeDef:
return {
"AppId": ...,
}
# ListBackendJobsRequestTypeDef definition
class ListBackendJobsRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
Operation: NotRequired[str],
Status: NotRequired[str],
ListS3BucketsRequestTypeDef#
# ListS3BucketsRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import ListS3BucketsRequestTypeDef
def get_value() -> ListS3BucketsRequestTypeDef:
return {
"NextToken": ...,
}
# ListS3BucketsRequestTypeDef definition
class ListS3BucketsRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
S3BucketInfoTypeDef#
# S3BucketInfoTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import S3BucketInfoTypeDef
def get_value() -> S3BucketInfoTypeDef:
return {
"CreationDate": ...,
}
# S3BucketInfoTypeDef definition
class S3BucketInfoTypeDef(TypedDict):
CreationDate: NotRequired[str],
Name: NotRequired[str],
LoginAuthConfigReqObjTypeDef#
# LoginAuthConfigReqObjTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import LoginAuthConfigReqObjTypeDef
def get_value() -> LoginAuthConfigReqObjTypeDef:
return {
"AwsCognitoIdentityPoolId": ...,
}
# LoginAuthConfigReqObjTypeDef definition
class LoginAuthConfigReqObjTypeDef(TypedDict):
AwsCognitoIdentityPoolId: NotRequired[str],
AwsCognitoRegion: NotRequired[str],
AwsUserPoolsId: NotRequired[str],
AwsUserPoolsWebClientId: NotRequired[str],
RemoveAllBackendsRequestTypeDef#
# RemoveAllBackendsRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import RemoveAllBackendsRequestTypeDef
def get_value() -> RemoveAllBackendsRequestTypeDef:
return {
"AppId": ...,
}
# RemoveAllBackendsRequestTypeDef definition
class RemoveAllBackendsRequestTypeDef(TypedDict):
AppId: str,
CleanAmplifyApp: NotRequired[bool],
RemoveBackendConfigRequestTypeDef#
# RemoveBackendConfigRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import RemoveBackendConfigRequestTypeDef
def get_value() -> RemoveBackendConfigRequestTypeDef:
return {
"AppId": ...,
}
# RemoveBackendConfigRequestTypeDef definition
class RemoveBackendConfigRequestTypeDef(TypedDict):
AppId: str,
UpdateBackendAuthIdentityPoolConfigTypeDef#
# UpdateBackendAuthIdentityPoolConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthIdentityPoolConfigTypeDef
def get_value() -> UpdateBackendAuthIdentityPoolConfigTypeDef:
return {
"UnauthenticatedLogin": ...,
}
# UpdateBackendAuthIdentityPoolConfigTypeDef definition
class UpdateBackendAuthIdentityPoolConfigTypeDef(TypedDict):
UnauthenticatedLogin: NotRequired[bool],
UpdateBackendAuthPasswordPolicyConfigTypeDef#
# UpdateBackendAuthPasswordPolicyConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthPasswordPolicyConfigTypeDef
def get_value() -> UpdateBackendAuthPasswordPolicyConfigTypeDef:
return {
"AdditionalConstraints": ...,
}
# UpdateBackendAuthPasswordPolicyConfigTypeDef definition
class UpdateBackendAuthPasswordPolicyConfigTypeDef(TypedDict):
AdditionalConstraints: NotRequired[Sequence[AdditionalConstraintsElementType]], # (1)
MinimumLength: NotRequired[float],
UpdateBackendJobRequestTypeDef#
# UpdateBackendJobRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendJobRequestTypeDef
def get_value() -> UpdateBackendJobRequestTypeDef:
return {
"AppId": ...,
}
# UpdateBackendJobRequestTypeDef definition
class UpdateBackendJobRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: str,
Operation: NotRequired[str],
Status: NotRequired[str],
BackendAPIAuthTypeTypeDef#
# BackendAPIAuthTypeTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import BackendAPIAuthTypeTypeDef
def get_value() -> BackendAPIAuthTypeTypeDef:
return {
"Mode": ...,
}
# BackendAPIAuthTypeTypeDef definition
class BackendAPIAuthTypeTypeDef(TypedDict):
Mode: NotRequired[ModeType], # (1)
Settings: NotRequired[BackendAPIAppSyncAuthSettingsTypeDef], # (2)
SocialProviderSettingsTypeDef#
# SocialProviderSettingsTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import SocialProviderSettingsTypeDef
def get_value() -> SocialProviderSettingsTypeDef:
return {
"Facebook": ...,
}
# SocialProviderSettingsTypeDef definition
class SocialProviderSettingsTypeDef(TypedDict):
Facebook: NotRequired[BackendAuthSocialProviderConfigTypeDef], # (1)
Google: NotRequired[BackendAuthSocialProviderConfigTypeDef], # (1)
LoginWithAmazon: NotRequired[BackendAuthSocialProviderConfigTypeDef], # (1)
SignInWithApple: NotRequired[BackendAuthAppleProviderConfigTypeDef], # (4)
- See BackendAuthSocialProviderConfigTypeDef
- See BackendAuthSocialProviderConfigTypeDef
- See BackendAuthSocialProviderConfigTypeDef
- See BackendAuthAppleProviderConfigTypeDef
GetBackendStorageResourceConfigTypeDef#
# GetBackendStorageResourceConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetBackendStorageResourceConfigTypeDef
def get_value() -> GetBackendStorageResourceConfigTypeDef:
return {
"BucketName": ...,
}
# GetBackendStorageResourceConfigTypeDef definition
class GetBackendStorageResourceConfigTypeDef(TypedDict):
Imported: bool,
ServiceName: ServiceNameType, # (2)
BucketName: NotRequired[str],
Permissions: NotRequired[BackendStoragePermissionsOutputTypeDef], # (1)
CloneBackendResponseTypeDef#
# CloneBackendResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CloneBackendResponseTypeDef
def get_value() -> CloneBackendResponseTypeDef:
return {
"AppId": ...,
}
# CloneBackendResponseTypeDef definition
class CloneBackendResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBackendAPIResponseTypeDef#
# CreateBackendAPIResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAPIResponseTypeDef
def get_value() -> CreateBackendAPIResponseTypeDef:
return {
"AppId": ...,
}
# CreateBackendAPIResponseTypeDef definition
class CreateBackendAPIResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBackendAuthResponseTypeDef#
# CreateBackendAuthResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthResponseTypeDef
def get_value() -> CreateBackendAuthResponseTypeDef:
return {
"AppId": ...,
}
# CreateBackendAuthResponseTypeDef definition
class CreateBackendAuthResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBackendConfigResponseTypeDef#
# CreateBackendConfigResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendConfigResponseTypeDef
def get_value() -> CreateBackendConfigResponseTypeDef:
return {
"AppId": ...,
}
# CreateBackendConfigResponseTypeDef definition
class CreateBackendConfigResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBackendResponseTypeDef#
# CreateBackendResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendResponseTypeDef
def get_value() -> CreateBackendResponseTypeDef:
return {
"AppId": ...,
}
# CreateBackendResponseTypeDef definition
class CreateBackendResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBackendStorageResponseTypeDef#
# CreateBackendStorageResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendStorageResponseTypeDef
def get_value() -> CreateBackendStorageResponseTypeDef:
return {
"AppId": ...,
}
# CreateBackendStorageResponseTypeDef definition
class CreateBackendStorageResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateTokenResponseTypeDef#
# CreateTokenResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateTokenResponseTypeDef
def get_value() -> CreateTokenResponseTypeDef:
return {
"AppId": ...,
}
# CreateTokenResponseTypeDef definition
class CreateTokenResponseTypeDef(TypedDict):
AppId: str,
ChallengeCode: str,
SessionId: str,
Ttl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteBackendAPIResponseTypeDef#
# DeleteBackendAPIResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendAPIResponseTypeDef
def get_value() -> DeleteBackendAPIResponseTypeDef:
return {
"AppId": ...,
}
# DeleteBackendAPIResponseTypeDef definition
class DeleteBackendAPIResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteBackendAuthResponseTypeDef#
# DeleteBackendAuthResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendAuthResponseTypeDef
def get_value() -> DeleteBackendAuthResponseTypeDef:
return {
"AppId": ...,
}
# DeleteBackendAuthResponseTypeDef definition
class DeleteBackendAuthResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteBackendResponseTypeDef#
# DeleteBackendResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendResponseTypeDef
def get_value() -> DeleteBackendResponseTypeDef:
return {
"AppId": ...,
}
# DeleteBackendResponseTypeDef definition
class DeleteBackendResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteBackendStorageResponseTypeDef#
# DeleteBackendStorageResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendStorageResponseTypeDef
def get_value() -> DeleteBackendStorageResponseTypeDef:
return {
"AppId": ...,
}
# DeleteBackendStorageResponseTypeDef definition
class DeleteBackendStorageResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteTokenResponseTypeDef#
# DeleteTokenResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import DeleteTokenResponseTypeDef
def get_value() -> DeleteTokenResponseTypeDef:
return {
"IsSuccess": ...,
}
# DeleteTokenResponseTypeDef definition
class DeleteTokenResponseTypeDef(TypedDict):
IsSuccess: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GenerateBackendAPIModelsResponseTypeDef#
# GenerateBackendAPIModelsResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GenerateBackendAPIModelsResponseTypeDef
def get_value() -> GenerateBackendAPIModelsResponseTypeDef:
return {
"AppId": ...,
}
# GenerateBackendAPIModelsResponseTypeDef definition
class GenerateBackendAPIModelsResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetBackendAPIModelsResponseTypeDef#
# GetBackendAPIModelsResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetBackendAPIModelsResponseTypeDef
def get_value() -> GetBackendAPIModelsResponseTypeDef:
return {
"Models": ...,
}
# GetBackendAPIModelsResponseTypeDef definition
class GetBackendAPIModelsResponseTypeDef(TypedDict):
Models: str,
Status: StatusType, # (1)
ModelIntrospectionSchema: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StatusType
- See ResponseMetadataTypeDef
GetBackendJobResponseTypeDef#
# GetBackendJobResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetBackendJobResponseTypeDef
def get_value() -> GetBackendJobResponseTypeDef:
return {
"AppId": ...,
}
# GetBackendJobResponseTypeDef definition
class GetBackendJobResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
CreateTime: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
UpdateTime: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetBackendResponseTypeDef#
# GetBackendResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetBackendResponseTypeDef
def get_value() -> GetBackendResponseTypeDef:
return {
"AmplifyFeatureFlags": ...,
}
# GetBackendResponseTypeDef definition
class GetBackendResponseTypeDef(TypedDict):
AmplifyFeatureFlags: str,
AmplifyMetaConfig: str,
AppId: str,
AppName: str,
BackendEnvironmentList: List[str],
BackendEnvironmentName: str,
Error: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetTokenResponseTypeDef#
# GetTokenResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetTokenResponseTypeDef
def get_value() -> GetTokenResponseTypeDef:
return {
"AppId": ...,
}
# GetTokenResponseTypeDef definition
class GetTokenResponseTypeDef(TypedDict):
AppId: str,
ChallengeCode: str,
SessionId: str,
Ttl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ImportBackendAuthResponseTypeDef#
# ImportBackendAuthResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import ImportBackendAuthResponseTypeDef
def get_value() -> ImportBackendAuthResponseTypeDef:
return {
"AppId": ...,
}
# ImportBackendAuthResponseTypeDef definition
class ImportBackendAuthResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ImportBackendStorageResponseTypeDef#
# ImportBackendStorageResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import ImportBackendStorageResponseTypeDef
def get_value() -> ImportBackendStorageResponseTypeDef:
return {
"AppId": ...,
}
# ImportBackendStorageResponseTypeDef definition
class ImportBackendStorageResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListBackendJobsResponseTypeDef#
# ListBackendJobsResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import ListBackendJobsResponseTypeDef
def get_value() -> ListBackendJobsResponseTypeDef:
return {
"Jobs": ...,
}
# ListBackendJobsResponseTypeDef definition
class ListBackendJobsResponseTypeDef(TypedDict):
Jobs: List[BackendJobRespObjTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
RemoveAllBackendsResponseTypeDef#
# RemoveAllBackendsResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import RemoveAllBackendsResponseTypeDef
def get_value() -> RemoveAllBackendsResponseTypeDef:
return {
"AppId": ...,
}
# RemoveAllBackendsResponseTypeDef definition
class RemoveAllBackendsResponseTypeDef(TypedDict):
AppId: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RemoveBackendConfigResponseTypeDef#
# RemoveBackendConfigResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import RemoveBackendConfigResponseTypeDef
def get_value() -> RemoveBackendConfigResponseTypeDef:
return {
"Error": ...,
}
# RemoveBackendConfigResponseTypeDef definition
class RemoveBackendConfigResponseTypeDef(TypedDict):
Error: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateBackendAPIResponseTypeDef#
# UpdateBackendAPIResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAPIResponseTypeDef
def get_value() -> UpdateBackendAPIResponseTypeDef:
return {
"AppId": ...,
}
# UpdateBackendAPIResponseTypeDef definition
class UpdateBackendAPIResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateBackendAuthResponseTypeDef#
# UpdateBackendAuthResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthResponseTypeDef
def get_value() -> UpdateBackendAuthResponseTypeDef:
return {
"AppId": ...,
}
# UpdateBackendAuthResponseTypeDef definition
class UpdateBackendAuthResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateBackendJobResponseTypeDef#
# UpdateBackendJobResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendJobResponseTypeDef
def get_value() -> UpdateBackendJobResponseTypeDef:
return {
"AppId": ...,
}
# UpdateBackendJobResponseTypeDef definition
class UpdateBackendJobResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
CreateTime: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
UpdateTime: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateBackendStorageResponseTypeDef#
# UpdateBackendStorageResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendStorageResponseTypeDef
def get_value() -> UpdateBackendStorageResponseTypeDef:
return {
"AppId": ...,
}
# UpdateBackendStorageResponseTypeDef definition
class UpdateBackendStorageResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBackendAuthForgotPasswordConfigTypeDef#
# CreateBackendAuthForgotPasswordConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthForgotPasswordConfigTypeDef
def get_value() -> CreateBackendAuthForgotPasswordConfigTypeDef:
return {
"DeliveryMethod": ...,
}
# CreateBackendAuthForgotPasswordConfigTypeDef definition
class CreateBackendAuthForgotPasswordConfigTypeDef(TypedDict):
DeliveryMethod: DeliveryMethodType, # (1)
EmailSettings: NotRequired[EmailSettingsTypeDef], # (2)
SmsSettings: NotRequired[SmsSettingsTypeDef], # (3)
- See DeliveryMethodType
- See EmailSettingsTypeDef
- See SmsSettingsTypeDef
CreateBackendAuthVerificationMessageConfigTypeDef#
# CreateBackendAuthVerificationMessageConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthVerificationMessageConfigTypeDef
def get_value() -> CreateBackendAuthVerificationMessageConfigTypeDef:
return {
"DeliveryMethod": ...,
}
# CreateBackendAuthVerificationMessageConfigTypeDef definition
class CreateBackendAuthVerificationMessageConfigTypeDef(TypedDict):
DeliveryMethod: DeliveryMethodType, # (1)
EmailSettings: NotRequired[EmailSettingsTypeDef], # (2)
SmsSettings: NotRequired[SmsSettingsTypeDef], # (3)
- See DeliveryMethodType
- See EmailSettingsTypeDef
- See SmsSettingsTypeDef
UpdateBackendAuthForgotPasswordConfigTypeDef#
# UpdateBackendAuthForgotPasswordConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthForgotPasswordConfigTypeDef
def get_value() -> UpdateBackendAuthForgotPasswordConfigTypeDef:
return {
"DeliveryMethod": ...,
}
# UpdateBackendAuthForgotPasswordConfigTypeDef definition
class UpdateBackendAuthForgotPasswordConfigTypeDef(TypedDict):
DeliveryMethod: NotRequired[DeliveryMethodType], # (1)
EmailSettings: NotRequired[EmailSettingsTypeDef], # (2)
SmsSettings: NotRequired[SmsSettingsTypeDef], # (3)
- See DeliveryMethodType
- See EmailSettingsTypeDef
- See SmsSettingsTypeDef
UpdateBackendAuthVerificationMessageConfigTypeDef#
# UpdateBackendAuthVerificationMessageConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthVerificationMessageConfigTypeDef
def get_value() -> UpdateBackendAuthVerificationMessageConfigTypeDef:
return {
"DeliveryMethod": ...,
}
# UpdateBackendAuthVerificationMessageConfigTypeDef definition
class UpdateBackendAuthVerificationMessageConfigTypeDef(TypedDict):
DeliveryMethod: DeliveryMethodType, # (1)
EmailSettings: NotRequired[EmailSettingsTypeDef], # (2)
SmsSettings: NotRequired[SmsSettingsTypeDef], # (3)
- See DeliveryMethodType
- See EmailSettingsTypeDef
- See SmsSettingsTypeDef
CreateBackendAuthMFAConfigOutputTypeDef#
# CreateBackendAuthMFAConfigOutputTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthMFAConfigOutputTypeDef
def get_value() -> CreateBackendAuthMFAConfigOutputTypeDef:
return {
"MFAMode": ...,
}
# CreateBackendAuthMFAConfigOutputTypeDef definition
class CreateBackendAuthMFAConfigOutputTypeDef(TypedDict):
MFAMode: MFAModeType, # (1)
Settings: NotRequired[SettingsOutputTypeDef], # (2)
- See MFAModeType
- See SettingsOutputTypeDef
CreateBackendAuthMFAConfigTypeDef#
# CreateBackendAuthMFAConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthMFAConfigTypeDef
def get_value() -> CreateBackendAuthMFAConfigTypeDef:
return {
"MFAMode": ...,
}
# CreateBackendAuthMFAConfigTypeDef definition
class CreateBackendAuthMFAConfigTypeDef(TypedDict):
MFAMode: MFAModeType, # (1)
Settings: NotRequired[SettingsTypeDef], # (2)
- See MFAModeType
- See SettingsTypeDef
ListBackendJobsRequestPaginateTypeDef#
# ListBackendJobsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import ListBackendJobsRequestPaginateTypeDef
def get_value() -> ListBackendJobsRequestPaginateTypeDef:
return {
"AppId": ...,
}
# ListBackendJobsRequestPaginateTypeDef definition
class ListBackendJobsRequestPaginateTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: NotRequired[str],
Operation: NotRequired[str],
Status: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListS3BucketsResponseTypeDef#
# ListS3BucketsResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import ListS3BucketsResponseTypeDef
def get_value() -> ListS3BucketsResponseTypeDef:
return {
"Buckets": ...,
}
# ListS3BucketsResponseTypeDef definition
class ListS3BucketsResponseTypeDef(TypedDict):
Buckets: List[S3BucketInfoTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
UpdateBackendConfigRequestTypeDef#
# UpdateBackendConfigRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendConfigRequestTypeDef
def get_value() -> UpdateBackendConfigRequestTypeDef:
return {
"AppId": ...,
}
# UpdateBackendConfigRequestTypeDef definition
class UpdateBackendConfigRequestTypeDef(TypedDict):
AppId: str,
LoginAuthConfig: NotRequired[LoginAuthConfigReqObjTypeDef], # (1)
UpdateBackendConfigResponseTypeDef#
# UpdateBackendConfigResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendConfigResponseTypeDef
def get_value() -> UpdateBackendConfigResponseTypeDef:
return {
"AppId": ...,
}
# UpdateBackendConfigResponseTypeDef definition
class UpdateBackendConfigResponseTypeDef(TypedDict):
AppId: str,
BackendManagerAppId: str,
Error: str,
LoginAuthConfig: LoginAuthConfigReqObjTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BackendAPIResourceConfigOutputTypeDef#
# BackendAPIResourceConfigOutputTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import BackendAPIResourceConfigOutputTypeDef
def get_value() -> BackendAPIResourceConfigOutputTypeDef:
return {
"AdditionalAuthTypes": ...,
}
# BackendAPIResourceConfigOutputTypeDef definition
class BackendAPIResourceConfigOutputTypeDef(TypedDict):
AdditionalAuthTypes: NotRequired[List[BackendAPIAuthTypeTypeDef]], # (1)
ApiName: NotRequired[str],
ConflictResolution: NotRequired[BackendAPIConflictResolutionTypeDef], # (2)
DefaultAuthType: NotRequired[BackendAPIAuthTypeTypeDef], # (3)
Service: NotRequired[str],
TransformSchema: NotRequired[str],
BackendAPIResourceConfigTypeDef#
# BackendAPIResourceConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import BackendAPIResourceConfigTypeDef
def get_value() -> BackendAPIResourceConfigTypeDef:
return {
"AdditionalAuthTypes": ...,
}
# BackendAPIResourceConfigTypeDef definition
class BackendAPIResourceConfigTypeDef(TypedDict):
AdditionalAuthTypes: NotRequired[Sequence[BackendAPIAuthTypeTypeDef]], # (1)
ApiName: NotRequired[str],
ConflictResolution: NotRequired[BackendAPIConflictResolutionTypeDef], # (2)
DefaultAuthType: NotRequired[BackendAPIAuthTypeTypeDef], # (3)
Service: NotRequired[str],
TransformSchema: NotRequired[str],
CreateBackendAuthOAuthConfigOutputTypeDef#
# CreateBackendAuthOAuthConfigOutputTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthOAuthConfigOutputTypeDef
def get_value() -> CreateBackendAuthOAuthConfigOutputTypeDef:
return {
"DomainPrefix": ...,
}
# CreateBackendAuthOAuthConfigOutputTypeDef definition
class CreateBackendAuthOAuthConfigOutputTypeDef(TypedDict):
OAuthGrantType: OAuthGrantTypeType, # (1)
OAuthScopes: List[OAuthScopesElementType], # (2)
RedirectSignInURIs: List[str],
RedirectSignOutURIs: List[str],
DomainPrefix: NotRequired[str],
SocialProviderSettings: NotRequired[SocialProviderSettingsTypeDef], # (3)
CreateBackendAuthOAuthConfigTypeDef#
# CreateBackendAuthOAuthConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthOAuthConfigTypeDef
def get_value() -> CreateBackendAuthOAuthConfigTypeDef:
return {
"DomainPrefix": ...,
}
# CreateBackendAuthOAuthConfigTypeDef definition
class CreateBackendAuthOAuthConfigTypeDef(TypedDict):
OAuthGrantType: OAuthGrantTypeType, # (1)
OAuthScopes: Sequence[OAuthScopesElementType], # (2)
RedirectSignInURIs: Sequence[str],
RedirectSignOutURIs: Sequence[str],
DomainPrefix: NotRequired[str],
SocialProviderSettings: NotRequired[SocialProviderSettingsTypeDef], # (3)
UpdateBackendAuthOAuthConfigTypeDef#
# UpdateBackendAuthOAuthConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthOAuthConfigTypeDef
def get_value() -> UpdateBackendAuthOAuthConfigTypeDef:
return {
"DomainPrefix": ...,
}
# UpdateBackendAuthOAuthConfigTypeDef definition
class UpdateBackendAuthOAuthConfigTypeDef(TypedDict):
DomainPrefix: NotRequired[str],
OAuthGrantType: NotRequired[OAuthGrantTypeType], # (1)
OAuthScopes: NotRequired[Sequence[OAuthScopesElementType]], # (2)
RedirectSignInURIs: NotRequired[Sequence[str]],
RedirectSignOutURIs: NotRequired[Sequence[str]],
SocialProviderSettings: NotRequired[SocialProviderSettingsTypeDef], # (3)
GetBackendStorageResponseTypeDef#
# GetBackendStorageResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetBackendStorageResponseTypeDef
def get_value() -> GetBackendStorageResponseTypeDef:
return {
"AppId": ...,
}
# GetBackendStorageResponseTypeDef definition
class GetBackendStorageResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceConfig: GetBackendStorageResourceConfigTypeDef, # (1)
ResourceName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateBackendStorageResourceConfigTypeDef#
# CreateBackendStorageResourceConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendStorageResourceConfigTypeDef
def get_value() -> CreateBackendStorageResourceConfigTypeDef:
return {
"BucketName": ...,
}
# CreateBackendStorageResourceConfigTypeDef definition
class CreateBackendStorageResourceConfigTypeDef(TypedDict):
Permissions: BackendStoragePermissionsUnionTypeDef, # (1)
ServiceName: ServiceNameType, # (2)
BucketName: NotRequired[str],
UpdateBackendStorageResourceConfigTypeDef#
# UpdateBackendStorageResourceConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendStorageResourceConfigTypeDef
def get_value() -> UpdateBackendStorageResourceConfigTypeDef:
return {
"Permissions": ...,
}
# UpdateBackendStorageResourceConfigTypeDef definition
class UpdateBackendStorageResourceConfigTypeDef(TypedDict):
Permissions: BackendStoragePermissionsUnionTypeDef, # (1)
ServiceName: ServiceNameType, # (2)
UpdateBackendAuthMFAConfigTypeDef#
# UpdateBackendAuthMFAConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthMFAConfigTypeDef
def get_value() -> UpdateBackendAuthMFAConfigTypeDef:
return {
"MFAMode": ...,
}
# UpdateBackendAuthMFAConfigTypeDef definition
class UpdateBackendAuthMFAConfigTypeDef(TypedDict):
MFAMode: NotRequired[MFAModeType], # (1)
Settings: NotRequired[SettingsUnionTypeDef], # (2)
GetBackendAPIResponseTypeDef#
# GetBackendAPIResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetBackendAPIResponseTypeDef
def get_value() -> GetBackendAPIResponseTypeDef:
return {
"AppId": ...,
}
# GetBackendAPIResponseTypeDef definition
class GetBackendAPIResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
ResourceConfig: BackendAPIResourceConfigOutputTypeDef, # (1)
ResourceName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateBackendAuthUserPoolConfigOutputTypeDef#
# CreateBackendAuthUserPoolConfigOutputTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthUserPoolConfigOutputTypeDef
def get_value() -> CreateBackendAuthUserPoolConfigOutputTypeDef:
return {
"ForgotPassword": ...,
}
# CreateBackendAuthUserPoolConfigOutputTypeDef definition
class CreateBackendAuthUserPoolConfigOutputTypeDef(TypedDict):
RequiredSignUpAttributes: List[RequiredSignUpAttributesElementType], # (5)
SignInMethod: SignInMethodType, # (6)
UserPoolName: str,
ForgotPassword: NotRequired[CreateBackendAuthForgotPasswordConfigTypeDef], # (1)
Mfa: NotRequired[CreateBackendAuthMFAConfigOutputTypeDef], # (2)
OAuth: NotRequired[CreateBackendAuthOAuthConfigOutputTypeDef], # (3)
PasswordPolicy: NotRequired[CreateBackendAuthPasswordPolicyConfigOutputTypeDef], # (4)
VerificationMessage: NotRequired[CreateBackendAuthVerificationMessageConfigTypeDef], # (7)
- See CreateBackendAuthForgotPasswordConfigTypeDef
- See CreateBackendAuthMFAConfigOutputTypeDef
- See CreateBackendAuthOAuthConfigOutputTypeDef
- See CreateBackendAuthPasswordPolicyConfigOutputTypeDef
- See RequiredSignUpAttributesElementType
- See SignInMethodType
- See CreateBackendAuthVerificationMessageConfigTypeDef
CreateBackendAuthUserPoolConfigTypeDef#
# CreateBackendAuthUserPoolConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthUserPoolConfigTypeDef
def get_value() -> CreateBackendAuthUserPoolConfigTypeDef:
return {
"ForgotPassword": ...,
}
# CreateBackendAuthUserPoolConfigTypeDef definition
class CreateBackendAuthUserPoolConfigTypeDef(TypedDict):
RequiredSignUpAttributes: Sequence[RequiredSignUpAttributesElementType], # (5)
SignInMethod: SignInMethodType, # (6)
UserPoolName: str,
ForgotPassword: NotRequired[CreateBackendAuthForgotPasswordConfigTypeDef], # (1)
Mfa: NotRequired[CreateBackendAuthMFAConfigTypeDef], # (2)
OAuth: NotRequired[CreateBackendAuthOAuthConfigTypeDef], # (3)
PasswordPolicy: NotRequired[CreateBackendAuthPasswordPolicyConfigTypeDef], # (4)
VerificationMessage: NotRequired[CreateBackendAuthVerificationMessageConfigTypeDef], # (7)
- See CreateBackendAuthForgotPasswordConfigTypeDef
- See CreateBackendAuthMFAConfigTypeDef
- See CreateBackendAuthOAuthConfigTypeDef
- See CreateBackendAuthPasswordPolicyConfigTypeDef
- See RequiredSignUpAttributesElementType
- See SignInMethodType
- See CreateBackendAuthVerificationMessageConfigTypeDef
CreateBackendStorageRequestTypeDef#
# CreateBackendStorageRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendStorageRequestTypeDef
def get_value() -> CreateBackendStorageRequestTypeDef:
return {
"AppId": ...,
}
# CreateBackendStorageRequestTypeDef definition
class CreateBackendStorageRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceConfig: CreateBackendStorageResourceConfigTypeDef, # (1)
ResourceName: str,
UpdateBackendStorageRequestTypeDef#
# UpdateBackendStorageRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendStorageRequestTypeDef
def get_value() -> UpdateBackendStorageRequestTypeDef:
return {
"AppId": ...,
}
# UpdateBackendStorageRequestTypeDef definition
class UpdateBackendStorageRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceConfig: UpdateBackendStorageResourceConfigTypeDef, # (1)
ResourceName: str,
UpdateBackendAuthUserPoolConfigTypeDef#
# UpdateBackendAuthUserPoolConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthUserPoolConfigTypeDef
def get_value() -> UpdateBackendAuthUserPoolConfigTypeDef:
return {
"ForgotPassword": ...,
}
# UpdateBackendAuthUserPoolConfigTypeDef definition
class UpdateBackendAuthUserPoolConfigTypeDef(TypedDict):
ForgotPassword: NotRequired[UpdateBackendAuthForgotPasswordConfigTypeDef], # (1)
Mfa: NotRequired[UpdateBackendAuthMFAConfigTypeDef], # (2)
OAuth: NotRequired[UpdateBackendAuthOAuthConfigTypeDef], # (3)
PasswordPolicy: NotRequired[UpdateBackendAuthPasswordPolicyConfigTypeDef], # (4)
VerificationMessage: NotRequired[UpdateBackendAuthVerificationMessageConfigTypeDef], # (5)
- See UpdateBackendAuthForgotPasswordConfigTypeDef
- See UpdateBackendAuthMFAConfigTypeDef
- See UpdateBackendAuthOAuthConfigTypeDef
- See UpdateBackendAuthPasswordPolicyConfigTypeDef
- See UpdateBackendAuthVerificationMessageConfigTypeDef
CreateBackendAPIRequestTypeDef#
# CreateBackendAPIRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAPIRequestTypeDef
def get_value() -> CreateBackendAPIRequestTypeDef:
return {
"AppId": ...,
}
# CreateBackendAPIRequestTypeDef definition
class CreateBackendAPIRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceConfig: BackendAPIResourceConfigUnionTypeDef, # (1)
ResourceName: str,
DeleteBackendAPIRequestTypeDef#
# DeleteBackendAPIRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendAPIRequestTypeDef
def get_value() -> DeleteBackendAPIRequestTypeDef:
return {
"AppId": ...,
}
# DeleteBackendAPIRequestTypeDef definition
class DeleteBackendAPIRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
ResourceConfig: NotRequired[BackendAPIResourceConfigUnionTypeDef], # (1)
GetBackendAPIRequestTypeDef#
# GetBackendAPIRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetBackendAPIRequestTypeDef
def get_value() -> GetBackendAPIRequestTypeDef:
return {
"AppId": ...,
}
# GetBackendAPIRequestTypeDef definition
class GetBackendAPIRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
ResourceConfig: NotRequired[BackendAPIResourceConfigUnionTypeDef], # (1)
UpdateBackendAPIRequestTypeDef#
# UpdateBackendAPIRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAPIRequestTypeDef
def get_value() -> UpdateBackendAPIRequestTypeDef:
return {
"AppId": ...,
}
# UpdateBackendAPIRequestTypeDef definition
class UpdateBackendAPIRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
ResourceConfig: NotRequired[BackendAPIResourceConfigUnionTypeDef], # (1)
CreateBackendAuthResourceConfigOutputTypeDef#
# CreateBackendAuthResourceConfigOutputTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthResourceConfigOutputTypeDef
def get_value() -> CreateBackendAuthResourceConfigOutputTypeDef:
return {
"AuthResources": ...,
}
# CreateBackendAuthResourceConfigOutputTypeDef definition
class CreateBackendAuthResourceConfigOutputTypeDef(TypedDict):
AuthResources: AuthResourcesType, # (1)
Service: ServiceType, # (3)
UserPoolConfigs: CreateBackendAuthUserPoolConfigOutputTypeDef, # (4)
IdentityPoolConfigs: NotRequired[CreateBackendAuthIdentityPoolConfigTypeDef], # (2)
- See AuthResourcesType
- See CreateBackendAuthIdentityPoolConfigTypeDef
- See ServiceType
- See CreateBackendAuthUserPoolConfigOutputTypeDef
CreateBackendAuthResourceConfigTypeDef#
# CreateBackendAuthResourceConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthResourceConfigTypeDef
def get_value() -> CreateBackendAuthResourceConfigTypeDef:
return {
"AuthResources": ...,
}
# CreateBackendAuthResourceConfigTypeDef definition
class CreateBackendAuthResourceConfigTypeDef(TypedDict):
AuthResources: AuthResourcesType, # (1)
Service: ServiceType, # (3)
UserPoolConfigs: CreateBackendAuthUserPoolConfigTypeDef, # (4)
IdentityPoolConfigs: NotRequired[CreateBackendAuthIdentityPoolConfigTypeDef], # (2)
- See AuthResourcesType
- See CreateBackendAuthIdentityPoolConfigTypeDef
- See ServiceType
- See CreateBackendAuthUserPoolConfigTypeDef
UpdateBackendAuthResourceConfigTypeDef#
# UpdateBackendAuthResourceConfigTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthResourceConfigTypeDef
def get_value() -> UpdateBackendAuthResourceConfigTypeDef:
return {
"AuthResources": ...,
}
# UpdateBackendAuthResourceConfigTypeDef definition
class UpdateBackendAuthResourceConfigTypeDef(TypedDict):
AuthResources: AuthResourcesType, # (1)
Service: ServiceType, # (3)
UserPoolConfigs: UpdateBackendAuthUserPoolConfigTypeDef, # (4)
IdentityPoolConfigs: NotRequired[UpdateBackendAuthIdentityPoolConfigTypeDef], # (2)
- See AuthResourcesType
- See UpdateBackendAuthIdentityPoolConfigTypeDef
- See ServiceType
- See UpdateBackendAuthUserPoolConfigTypeDef
GetBackendAuthResponseTypeDef#
# GetBackendAuthResponseTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import GetBackendAuthResponseTypeDef
def get_value() -> GetBackendAuthResponseTypeDef:
return {
"AppId": ...,
}
# GetBackendAuthResponseTypeDef definition
class GetBackendAuthResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
ResourceConfig: CreateBackendAuthResourceConfigOutputTypeDef, # (1)
ResourceName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateBackendAuthRequestTypeDef#
# UpdateBackendAuthRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthRequestTypeDef
def get_value() -> UpdateBackendAuthRequestTypeDef:
return {
"AppId": ...,
}
# UpdateBackendAuthRequestTypeDef definition
class UpdateBackendAuthRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceConfig: UpdateBackendAuthResourceConfigTypeDef, # (1)
ResourceName: str,
CreateBackendAuthRequestTypeDef#
# CreateBackendAuthRequestTypeDef TypedDict usage example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthRequestTypeDef
def get_value() -> CreateBackendAuthRequestTypeDef:
return {
"AppId": ...,
}
# CreateBackendAuthRequestTypeDef definition
class CreateBackendAuthRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceConfig: CreateBackendAuthResourceConfigUnionTypeDef, # (1)
ResourceName: str,