Type definitions#
Index > AmplifyBackend > Type definitions
Auto-generated documentation for AmplifyBackend type annotations stubs module mypy-boto3-amplifybackend.
BackendAPIAppSyncAuthSettingsTypeDef#
# 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 definition
class BackendAPIConflictResolutionTypeDef(TypedDict):
ResolutionStrategy: NotRequired[ResolutionStrategyType], # (1)
BackendAuthAppleProviderConfigTypeDef#
# BackendAuthAppleProviderConfigTypeDef definition
class BackendAuthAppleProviderConfigTypeDef(TypedDict):
ClientId: NotRequired[str],
KeyId: NotRequired[str],
PrivateKey: NotRequired[str],
TeamId: NotRequired[str],
BackendAuthSocialProviderConfigTypeDef#
# BackendAuthSocialProviderConfigTypeDef definition
class BackendAuthSocialProviderConfigTypeDef(TypedDict):
ClientId: NotRequired[str],
ClientSecret: NotRequired[str],
BackendJobRespObjTypeDef#
# 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],
BackendStoragePermissionsTypeDef#
# BackendStoragePermissionsTypeDef definition
class BackendStoragePermissionsTypeDef(TypedDict):
Authenticated: Sequence[AuthenticatedElementType], # (1)
UnAuthenticated: NotRequired[Sequence[UnAuthenticatedElementType]], # (2)
CloneBackendRequestRequestTypeDef#
# CloneBackendRequestRequestTypeDef definition
class CloneBackendRequestRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
TargetEnvironmentName: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
EmailSettingsTypeDef#
# EmailSettingsTypeDef definition
class EmailSettingsTypeDef(TypedDict):
EmailMessage: NotRequired[str],
EmailSubject: NotRequired[str],
SmsSettingsTypeDef#
# SmsSettingsTypeDef definition
class SmsSettingsTypeDef(TypedDict):
SmsMessage: NotRequired[str],
CreateBackendAuthIdentityPoolConfigTypeDef#
# CreateBackendAuthIdentityPoolConfigTypeDef definition
class CreateBackendAuthIdentityPoolConfigTypeDef(TypedDict):
IdentityPoolName: str,
UnauthenticatedLogin: bool,
SettingsTypeDef#
# SettingsTypeDef definition
class SettingsTypeDef(TypedDict):
MfaTypes: NotRequired[Sequence[MfaTypesElementType]], # (1)
SmsMessage: NotRequired[str],
CreateBackendAuthPasswordPolicyConfigTypeDef#
# CreateBackendAuthPasswordPolicyConfigTypeDef definition
class CreateBackendAuthPasswordPolicyConfigTypeDef(TypedDict):
MinimumLength: float,
AdditionalConstraints: NotRequired[Sequence[AdditionalConstraintsElementType]], # (1)
CreateBackendConfigRequestRequestTypeDef#
# CreateBackendConfigRequestRequestTypeDef definition
class CreateBackendConfigRequestRequestTypeDef(TypedDict):
AppId: str,
BackendManagerAppId: NotRequired[str],
CreateBackendRequestRequestTypeDef#
# CreateBackendRequestRequestTypeDef definition
class CreateBackendRequestRequestTypeDef(TypedDict):
AppId: str,
AppName: str,
BackendEnvironmentName: str,
ResourceConfig: NotRequired[Mapping[str, Any]],
ResourceName: NotRequired[str],
CreateTokenRequestRequestTypeDef#
# CreateTokenRequestRequestTypeDef definition
class CreateTokenRequestRequestTypeDef(TypedDict):
AppId: str,
DeleteBackendAuthRequestRequestTypeDef#
# DeleteBackendAuthRequestRequestTypeDef definition
class DeleteBackendAuthRequestRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
DeleteBackendRequestRequestTypeDef#
# DeleteBackendRequestRequestTypeDef definition
class DeleteBackendRequestRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
DeleteBackendStorageRequestRequestTypeDef#
# DeleteBackendStorageRequestRequestTypeDef definition
class DeleteBackendStorageRequestRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
ServiceName: ServiceNameType, # (1)
- See ServiceNameType
DeleteTokenRequestRequestTypeDef#
# DeleteTokenRequestRequestTypeDef definition
class DeleteTokenRequestRequestTypeDef(TypedDict):
AppId: str,
SessionId: str,
GenerateBackendAPIModelsRequestRequestTypeDef#
# GenerateBackendAPIModelsRequestRequestTypeDef definition
class GenerateBackendAPIModelsRequestRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
GetBackendAPIModelsRequestRequestTypeDef#
# GetBackendAPIModelsRequestRequestTypeDef definition
class GetBackendAPIModelsRequestRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
GetBackendAuthRequestRequestTypeDef#
# GetBackendAuthRequestRequestTypeDef definition
class GetBackendAuthRequestRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
GetBackendJobRequestRequestTypeDef#
# GetBackendJobRequestRequestTypeDef definition
class GetBackendJobRequestRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: str,
GetBackendRequestRequestTypeDef#
# GetBackendRequestRequestTypeDef definition
class GetBackendRequestRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: NotRequired[str],
GetBackendStorageRequestRequestTypeDef#
# GetBackendStorageRequestRequestTypeDef definition
class GetBackendStorageRequestRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
GetTokenRequestRequestTypeDef#
# GetTokenRequestRequestTypeDef definition
class GetTokenRequestRequestTypeDef(TypedDict):
AppId: str,
SessionId: str,
ImportBackendAuthRequestRequestTypeDef#
# ImportBackendAuthRequestRequestTypeDef definition
class ImportBackendAuthRequestRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
NativeClientId: str,
UserPoolId: str,
WebClientId: str,
IdentityPoolId: NotRequired[str],
ImportBackendStorageRequestRequestTypeDef#
# ImportBackendStorageRequestRequestTypeDef definition
class ImportBackendStorageRequestRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
ServiceName: ServiceNameType, # (1)
BucketName: NotRequired[str],
- See ServiceNameType
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListBackendJobsRequestRequestTypeDef#
# ListBackendJobsRequestRequestTypeDef definition
class ListBackendJobsRequestRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
Operation: NotRequired[str],
Status: NotRequired[str],
ListS3BucketsRequestRequestTypeDef#
# ListS3BucketsRequestRequestTypeDef definition
class ListS3BucketsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
S3BucketInfoTypeDef#
# S3BucketInfoTypeDef definition
class S3BucketInfoTypeDef(TypedDict):
CreationDate: NotRequired[str],
Name: NotRequired[str],
LoginAuthConfigReqObjTypeDef#
# LoginAuthConfigReqObjTypeDef definition
class LoginAuthConfigReqObjTypeDef(TypedDict):
AwsCognitoIdentityPoolId: NotRequired[str],
AwsCognitoRegion: NotRequired[str],
AwsUserPoolsId: NotRequired[str],
AwsUserPoolsWebClientId: NotRequired[str],
RemoveAllBackendsRequestRequestTypeDef#
# RemoveAllBackendsRequestRequestTypeDef definition
class RemoveAllBackendsRequestRequestTypeDef(TypedDict):
AppId: str,
CleanAmplifyApp: NotRequired[bool],
RemoveBackendConfigRequestRequestTypeDef#
# RemoveBackendConfigRequestRequestTypeDef definition
class RemoveBackendConfigRequestRequestTypeDef(TypedDict):
AppId: str,
UpdateBackendAuthIdentityPoolConfigTypeDef#
# UpdateBackendAuthIdentityPoolConfigTypeDef definition
class UpdateBackendAuthIdentityPoolConfigTypeDef(TypedDict):
UnauthenticatedLogin: NotRequired[bool],
UpdateBackendAuthPasswordPolicyConfigTypeDef#
# UpdateBackendAuthPasswordPolicyConfigTypeDef definition
class UpdateBackendAuthPasswordPolicyConfigTypeDef(TypedDict):
AdditionalConstraints: NotRequired[Sequence[AdditionalConstraintsElementType]], # (1)
MinimumLength: NotRequired[float],
UpdateBackendJobRequestRequestTypeDef#
# UpdateBackendJobRequestRequestTypeDef definition
class UpdateBackendJobRequestRequestTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: str,
Operation: NotRequired[str],
Status: NotRequired[str],
BackendAPIAuthTypeTypeDef#
# BackendAPIAuthTypeTypeDef definition
class BackendAPIAuthTypeTypeDef(TypedDict):
Mode: NotRequired[ModeType], # (1)
Settings: NotRequired[BackendAPIAppSyncAuthSettingsTypeDef], # (2)
SocialProviderSettingsTypeDef#
# 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
CreateBackendStorageResourceConfigTypeDef#
# CreateBackendStorageResourceConfigTypeDef definition
class CreateBackendStorageResourceConfigTypeDef(TypedDict):
Permissions: BackendStoragePermissionsTypeDef, # (1)
ServiceName: ServiceNameType, # (2)
BucketName: NotRequired[str],
GetBackendStorageResourceConfigTypeDef#
# GetBackendStorageResourceConfigTypeDef definition
class GetBackendStorageResourceConfigTypeDef(TypedDict):
Imported: bool,
ServiceName: ServiceNameType, # (2)
BucketName: NotRequired[str],
Permissions: NotRequired[BackendStoragePermissionsTypeDef], # (1)
UpdateBackendStorageResourceConfigTypeDef#
# UpdateBackendStorageResourceConfigTypeDef definition
class UpdateBackendStorageResourceConfigTypeDef(TypedDict):
Permissions: BackendStoragePermissionsTypeDef, # (1)
ServiceName: ServiceNameType, # (2)
CloneBackendResponseTypeDef#
# CloneBackendResponseTypeDef definition
class CloneBackendResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBackendAPIResponseTypeDef#
# CreateBackendAPIResponseTypeDef definition
class CreateBackendAPIResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBackendAuthResponseTypeDef#
# CreateBackendAuthResponseTypeDef definition
class CreateBackendAuthResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBackendConfigResponseTypeDef#
# CreateBackendConfigResponseTypeDef definition
class CreateBackendConfigResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBackendResponseTypeDef#
# CreateBackendResponseTypeDef definition
class CreateBackendResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBackendStorageResponseTypeDef#
# CreateBackendStorageResponseTypeDef definition
class CreateBackendStorageResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateTokenResponseTypeDef#
# CreateTokenResponseTypeDef definition
class CreateTokenResponseTypeDef(TypedDict):
AppId: str,
ChallengeCode: str,
SessionId: str,
Ttl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteBackendAPIResponseTypeDef#
# DeleteBackendAPIResponseTypeDef definition
class DeleteBackendAPIResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteBackendAuthResponseTypeDef#
# DeleteBackendAuthResponseTypeDef definition
class DeleteBackendAuthResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteBackendResponseTypeDef#
# DeleteBackendResponseTypeDef definition
class DeleteBackendResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteBackendStorageResponseTypeDef#
# DeleteBackendStorageResponseTypeDef definition
class DeleteBackendStorageResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteTokenResponseTypeDef#
# DeleteTokenResponseTypeDef definition
class DeleteTokenResponseTypeDef(TypedDict):
IsSuccess: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GenerateBackendAPIModelsResponseTypeDef#
# GenerateBackendAPIModelsResponseTypeDef definition
class GenerateBackendAPIModelsResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetBackendAPIModelsResponseTypeDef#
# GetBackendAPIModelsResponseTypeDef definition
class GetBackendAPIModelsResponseTypeDef(TypedDict):
Models: str,
Status: StatusType, # (1)
ModelIntrospectionSchema: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StatusType
- See ResponseMetadataTypeDef
GetBackendJobResponseTypeDef#
# 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 definition
class GetBackendResponseTypeDef(TypedDict):
AmplifyFeatureFlags: str,
AmplifyMetaConfig: str,
AppId: str,
AppName: str,
BackendEnvironmentList: List[str],
BackendEnvironmentName: str,
Error: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetTokenResponseTypeDef#
# GetTokenResponseTypeDef definition
class GetTokenResponseTypeDef(TypedDict):
AppId: str,
ChallengeCode: str,
SessionId: str,
Ttl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ImportBackendAuthResponseTypeDef#
# ImportBackendAuthResponseTypeDef definition
class ImportBackendAuthResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ImportBackendStorageResponseTypeDef#
# ImportBackendStorageResponseTypeDef definition
class ImportBackendStorageResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListBackendJobsResponseTypeDef#
# ListBackendJobsResponseTypeDef definition
class ListBackendJobsResponseTypeDef(TypedDict):
Jobs: List[BackendJobRespObjTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RemoveAllBackendsResponseTypeDef#
# RemoveAllBackendsResponseTypeDef definition
class RemoveAllBackendsResponseTypeDef(TypedDict):
AppId: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RemoveBackendConfigResponseTypeDef#
# RemoveBackendConfigResponseTypeDef definition
class RemoveBackendConfigResponseTypeDef(TypedDict):
Error: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateBackendAPIResponseTypeDef#
# UpdateBackendAPIResponseTypeDef definition
class UpdateBackendAPIResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateBackendAuthResponseTypeDef#
# UpdateBackendAuthResponseTypeDef definition
class UpdateBackendAuthResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
Error: str,
JobId: str,
Operation: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateBackendJobResponseTypeDef#
# 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 definition
class UpdateBackendStorageResponseTypeDef(TypedDict):
AppId: str,
BackendEnvironmentName: str,
JobId: str,
Status: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBackendAuthForgotPasswordConfigTypeDef#
# CreateBackendAuthForgotPasswordConfigTypeDef definition
class CreateBackendAuthForgotPasswordConfigTypeDef(TypedDict):
DeliveryMethod: DeliveryMethodType, # (1)
EmailSettings: NotRequired[EmailSettingsTypeDef], # (2)
SmsSettings: NotRequired[SmsSettingsTypeDef], # (3)
- See DeliveryMethodType
- See