Skip to content

Typed dictionaries

Index > AmplifyBackend > Typed dictionaries

Auto-generated documentation for AmplifyBackend type annotations stubs module mypy-boto3-amplifybackend.

BackendAPIAppSyncAuthSettingsTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import BackendAPIAppSyncAuthSettingsTypeDef

def get_value() -> BackendAPIAppSyncAuthSettingsTypeDef:
    return {
        "CognitoUserPoolId": ...,
    }
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

Usage Example
from mypy_boto3_amplifybackend.type_defs import BackendAPIConflictResolutionTypeDef

def get_value() -> BackendAPIConflictResolutionTypeDef:
    return {
        "ResolutionStrategy": ...,
    }
Definition
class BackendAPIConflictResolutionTypeDef(TypedDict):
    ResolutionStrategy: NotRequired[ResolutionStrategyType],  # (1)
  1. See ResolutionStrategyType

BackendAuthAppleProviderConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import BackendAuthAppleProviderConfigTypeDef

def get_value() -> BackendAuthAppleProviderConfigTypeDef:
    return {
        "ClientId": ...,
    }
Definition
class BackendAuthAppleProviderConfigTypeDef(TypedDict):
    ClientId: NotRequired[str],
    KeyId: NotRequired[str],
    PrivateKey: NotRequired[str],
    TeamId: NotRequired[str],

BackendAuthSocialProviderConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import BackendAuthSocialProviderConfigTypeDef

def get_value() -> BackendAuthSocialProviderConfigTypeDef:
    return {
        "ClientId": ...,
    }
Definition
class BackendAuthSocialProviderConfigTypeDef(TypedDict):
    ClientId: NotRequired[str],
    ClientSecret: NotRequired[str],

BackendJobRespObjTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import BackendJobRespObjTypeDef

def get_value() -> BackendJobRespObjTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
    }
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

Usage Example
from mypy_boto3_amplifybackend.type_defs import BackendStoragePermissionsTypeDef

def get_value() -> BackendStoragePermissionsTypeDef:
    return {
        "Authenticated": ...,
    }
Definition
class BackendStoragePermissionsTypeDef(TypedDict):
    Authenticated: Sequence[AuthenticatedElementType],  # (1)
    UnAuthenticated: NotRequired[Sequence[UnAuthenticatedElementType]],  # (2)
  1. See AuthenticatedElementType
  2. See UnAuthenticatedElementType

CloneBackendRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CloneBackendRequestRequestTypeDef

def get_value() -> CloneBackendRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "TargetEnvironmentName": ...,
    }
Definition
class CloneBackendRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    TargetEnvironmentName: str,

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

EmailSettingsTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import EmailSettingsTypeDef

def get_value() -> EmailSettingsTypeDef:
    return {
        "EmailMessage": ...,
    }
Definition
class EmailSettingsTypeDef(TypedDict):
    EmailMessage: NotRequired[str],
    EmailSubject: NotRequired[str],

SmsSettingsTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import SmsSettingsTypeDef

def get_value() -> SmsSettingsTypeDef:
    return {
        "SmsMessage": ...,
    }
Definition
class SmsSettingsTypeDef(TypedDict):
    SmsMessage: NotRequired[str],

CreateBackendAuthIdentityPoolConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthIdentityPoolConfigTypeDef

def get_value() -> CreateBackendAuthIdentityPoolConfigTypeDef:
    return {
        "IdentityPoolName": ...,
        "UnauthenticatedLogin": ...,
    }
Definition
class CreateBackendAuthIdentityPoolConfigTypeDef(TypedDict):
    IdentityPoolName: str,
    UnauthenticatedLogin: bool,

SettingsTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import SettingsTypeDef

def get_value() -> SettingsTypeDef:
    return {
        "MfaTypes": ...,
    }
Definition
class SettingsTypeDef(TypedDict):
    MfaTypes: NotRequired[Sequence[MfaTypesElementType]],  # (1)
    SmsMessage: NotRequired[str],
  1. See MfaTypesElementType

CreateBackendAuthPasswordPolicyConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthPasswordPolicyConfigTypeDef

def get_value() -> CreateBackendAuthPasswordPolicyConfigTypeDef:
    return {
        "MinimumLength": ...,
    }
Definition
class CreateBackendAuthPasswordPolicyConfigTypeDef(TypedDict):
    MinimumLength: float,
    AdditionalConstraints: NotRequired[Sequence[AdditionalConstraintsElementType]],  # (1)
  1. See AdditionalConstraintsElementType

CreateBackendConfigRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendConfigRequestRequestTypeDef

def get_value() -> CreateBackendConfigRequestRequestTypeDef:
    return {
        "AppId": ...,
    }
Definition
class CreateBackendConfigRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendManagerAppId: NotRequired[str],

CreateBackendRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendRequestRequestTypeDef

def get_value() -> CreateBackendRequestRequestTypeDef:
    return {
        "AppId": ...,
        "AppName": ...,
        "BackendEnvironmentName": ...,
    }
Definition
class CreateBackendRequestRequestTypeDef(TypedDict):
    AppId: str,
    AppName: str,
    BackendEnvironmentName: str,
    ResourceConfig: NotRequired[Mapping[str, Any]],
    ResourceName: NotRequired[str],

CreateTokenRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateTokenRequestRequestTypeDef

def get_value() -> CreateTokenRequestRequestTypeDef:
    return {
        "AppId": ...,
    }
Definition
class CreateTokenRequestRequestTypeDef(TypedDict):
    AppId: str,

DeleteBackendAuthRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendAuthRequestRequestTypeDef

def get_value() -> DeleteBackendAuthRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceName": ...,
    }
Definition
class DeleteBackendAuthRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,

DeleteBackendRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendRequestRequestTypeDef

def get_value() -> DeleteBackendRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
    }
Definition
class DeleteBackendRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,

DeleteBackendStorageRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendStorageRequestRequestTypeDef

def get_value() -> DeleteBackendStorageRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceName": ...,
        "ServiceName": ...,
    }
Definition
class DeleteBackendStorageRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
    ServiceName: ServiceNameType,  # (1)
  1. See ServiceNameType

DeleteTokenRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import DeleteTokenRequestRequestTypeDef

def get_value() -> DeleteTokenRequestRequestTypeDef:
    return {
        "AppId": ...,
        "SessionId": ...,
    }
Definition
class DeleteTokenRequestRequestTypeDef(TypedDict):
    AppId: str,
    SessionId: str,

GenerateBackendAPIModelsRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GenerateBackendAPIModelsRequestRequestTypeDef

def get_value() -> GenerateBackendAPIModelsRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceName": ...,
    }
Definition
class GenerateBackendAPIModelsRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,

GetBackendAPIModelsRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetBackendAPIModelsRequestRequestTypeDef

def get_value() -> GetBackendAPIModelsRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceName": ...,
    }
Definition
class GetBackendAPIModelsRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,

GetBackendAuthRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetBackendAuthRequestRequestTypeDef

def get_value() -> GetBackendAuthRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceName": ...,
    }
Definition
class GetBackendAuthRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,

GetBackendJobRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetBackendJobRequestRequestTypeDef

def get_value() -> GetBackendJobRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "JobId": ...,
    }
Definition
class GetBackendJobRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,

GetBackendRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetBackendRequestRequestTypeDef

def get_value() -> GetBackendRequestRequestTypeDef:
    return {
        "AppId": ...,
    }
Definition
class GetBackendRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: NotRequired[str],

GetBackendStorageRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetBackendStorageRequestRequestTypeDef

def get_value() -> GetBackendStorageRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceName": ...,
    }
Definition
class GetBackendStorageRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,

GetTokenRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetTokenRequestRequestTypeDef

def get_value() -> GetTokenRequestRequestTypeDef:
    return {
        "AppId": ...,
        "SessionId": ...,
    }
Definition
class GetTokenRequestRequestTypeDef(TypedDict):
    AppId: str,
    SessionId: str,

ImportBackendAuthRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import ImportBackendAuthRequestRequestTypeDef

def get_value() -> ImportBackendAuthRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "NativeClientId": ...,
        "UserPoolId": ...,
        "WebClientId": ...,
    }
Definition
class ImportBackendAuthRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    NativeClientId: str,
    UserPoolId: str,
    WebClientId: str,
    IdentityPoolId: NotRequired[str],

ImportBackendStorageRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import ImportBackendStorageRequestRequestTypeDef

def get_value() -> ImportBackendStorageRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ServiceName": ...,
    }
Definition
class ImportBackendStorageRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ServiceName: ServiceNameType,  # (1)
    BucketName: NotRequired[str],
  1. See ServiceNameType

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListBackendJobsRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import ListBackendJobsRequestRequestTypeDef

def get_value() -> ListBackendJobsRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
    }
Definition
class ListBackendJobsRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    Operation: NotRequired[str],
    Status: NotRequired[str],

ListS3BucketsRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import ListS3BucketsRequestRequestTypeDef

def get_value() -> ListS3BucketsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
Definition
class ListS3BucketsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],

S3BucketInfoTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import S3BucketInfoTypeDef

def get_value() -> S3BucketInfoTypeDef:
    return {
        "CreationDate": ...,
    }
Definition
class S3BucketInfoTypeDef(TypedDict):
    CreationDate: NotRequired[str],
    Name: NotRequired[str],

LoginAuthConfigReqObjTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import LoginAuthConfigReqObjTypeDef

def get_value() -> LoginAuthConfigReqObjTypeDef:
    return {
        "AwsCognitoIdentityPoolId": ...,
    }
Definition
class LoginAuthConfigReqObjTypeDef(TypedDict):
    AwsCognitoIdentityPoolId: NotRequired[str],
    AwsCognitoRegion: NotRequired[str],
    AwsUserPoolsId: NotRequired[str],
    AwsUserPoolsWebClientId: NotRequired[str],

RemoveAllBackendsRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import RemoveAllBackendsRequestRequestTypeDef

def get_value() -> RemoveAllBackendsRequestRequestTypeDef:
    return {
        "AppId": ...,
    }
Definition
class RemoveAllBackendsRequestRequestTypeDef(TypedDict):
    AppId: str,
    CleanAmplifyApp: NotRequired[bool],

RemoveBackendConfigRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import RemoveBackendConfigRequestRequestTypeDef

def get_value() -> RemoveBackendConfigRequestRequestTypeDef:
    return {
        "AppId": ...,
    }
Definition
class RemoveBackendConfigRequestRequestTypeDef(TypedDict):
    AppId: str,

UpdateBackendAuthIdentityPoolConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthIdentityPoolConfigTypeDef

def get_value() -> UpdateBackendAuthIdentityPoolConfigTypeDef:
    return {
        "UnauthenticatedLogin": ...,
    }
Definition
class UpdateBackendAuthIdentityPoolConfigTypeDef(TypedDict):
    UnauthenticatedLogin: NotRequired[bool],

UpdateBackendAuthPasswordPolicyConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthPasswordPolicyConfigTypeDef

def get_value() -> UpdateBackendAuthPasswordPolicyConfigTypeDef:
    return {
        "AdditionalConstraints": ...,
    }
Definition
class UpdateBackendAuthPasswordPolicyConfigTypeDef(TypedDict):
    AdditionalConstraints: NotRequired[Sequence[AdditionalConstraintsElementType]],  # (1)
    MinimumLength: NotRequired[float],
  1. See AdditionalConstraintsElementType

UpdateBackendJobRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendJobRequestRequestTypeDef

def get_value() -> UpdateBackendJobRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "JobId": ...,
    }
Definition
class UpdateBackendJobRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,
    Operation: NotRequired[str],
    Status: NotRequired[str],

BackendAPIAuthTypeTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import BackendAPIAuthTypeTypeDef

def get_value() -> BackendAPIAuthTypeTypeDef:
    return {
        "Mode": ...,
    }
Definition
class BackendAPIAuthTypeTypeDef(TypedDict):
    Mode: NotRequired[ModeType],  # (1)
    Settings: NotRequired[BackendAPIAppSyncAuthSettingsTypeDef],  # (2)
  1. See ModeType
  2. See BackendAPIAppSyncAuthSettingsTypeDef

SocialProviderSettingsTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import SocialProviderSettingsTypeDef

def get_value() -> SocialProviderSettingsTypeDef:
    return {
        "Facebook": ...,
    }
Definition
class SocialProviderSettingsTypeDef(TypedDict):
    Facebook: NotRequired[BackendAuthSocialProviderConfigTypeDef],  # (1)
    Google: NotRequired[BackendAuthSocialProviderConfigTypeDef],  # (1)
    LoginWithAmazon: NotRequired[BackendAuthSocialProviderConfigTypeDef],  # (1)
    SignInWithApple: NotRequired[BackendAuthAppleProviderConfigTypeDef],  # (4)
  1. See BackendAuthSocialProviderConfigTypeDef
  2. See BackendAuthSocialProviderConfigTypeDef
  3. See BackendAuthSocialProviderConfigTypeDef
  4. See BackendAuthAppleProviderConfigTypeDef

CreateBackendStorageResourceConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendStorageResourceConfigTypeDef

def get_value() -> CreateBackendStorageResourceConfigTypeDef:
    return {
        "Permissions": ...,
        "ServiceName": ...,
    }
Definition
class CreateBackendStorageResourceConfigTypeDef(TypedDict):
    Permissions: BackendStoragePermissionsTypeDef,  # (1)
    ServiceName: ServiceNameType,  # (2)
    BucketName: NotRequired[str],
  1. See BackendStoragePermissionsTypeDef
  2. See ServiceNameType

GetBackendStorageResourceConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetBackendStorageResourceConfigTypeDef

def get_value() -> GetBackendStorageResourceConfigTypeDef:
    return {
        "Imported": ...,
        "ServiceName": ...,
    }
Definition
class GetBackendStorageResourceConfigTypeDef(TypedDict):
    Imported: bool,
    ServiceName: ServiceNameType,  # (2)
    BucketName: NotRequired[str],
    Permissions: NotRequired[BackendStoragePermissionsTypeDef],  # (1)
  1. See BackendStoragePermissionsTypeDef
  2. See ServiceNameType

UpdateBackendStorageResourceConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendStorageResourceConfigTypeDef

def get_value() -> UpdateBackendStorageResourceConfigTypeDef:
    return {
        "Permissions": ...,
        "ServiceName": ...,
    }
Definition
class UpdateBackendStorageResourceConfigTypeDef(TypedDict):
    Permissions: BackendStoragePermissionsTypeDef,  # (1)
    ServiceName: ServiceNameType,  # (2)
  1. See BackendStoragePermissionsTypeDef
  2. See ServiceNameType

CloneBackendResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CloneBackendResponseTypeDef

def get_value() -> CloneBackendResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "Error": ...,
        "JobId": ...,
        "Operation": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class CloneBackendResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBackendAPIResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAPIResponseTypeDef

def get_value() -> CreateBackendAPIResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "Error": ...,
        "JobId": ...,
        "Operation": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateBackendAPIResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBackendAuthResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthResponseTypeDef

def get_value() -> CreateBackendAuthResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "Error": ...,
        "JobId": ...,
        "Operation": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateBackendAuthResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBackendConfigResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendConfigResponseTypeDef

def get_value() -> CreateBackendConfigResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "JobId": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateBackendConfigResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBackendResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendResponseTypeDef

def get_value() -> CreateBackendResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "Error": ...,
        "JobId": ...,
        "Operation": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateBackendResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBackendStorageResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendStorageResponseTypeDef

def get_value() -> CreateBackendStorageResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "JobId": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateBackendStorageResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTokenResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateTokenResponseTypeDef

def get_value() -> CreateTokenResponseTypeDef:
    return {
        "AppId": ...,
        "ChallengeCode": ...,
        "SessionId": ...,
        "Ttl": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateTokenResponseTypeDef(TypedDict):
    AppId: str,
    ChallengeCode: str,
    SessionId: str,
    Ttl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteBackendAPIResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendAPIResponseTypeDef

def get_value() -> DeleteBackendAPIResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "Error": ...,
        "JobId": ...,
        "Operation": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteBackendAPIResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteBackendAuthResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendAuthResponseTypeDef

def get_value() -> DeleteBackendAuthResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "Error": ...,
        "JobId": ...,
        "Operation": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteBackendAuthResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteBackendResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendResponseTypeDef

def get_value() -> DeleteBackendResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "Error": ...,
        "JobId": ...,
        "Operation": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteBackendResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteBackendStorageResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendStorageResponseTypeDef

def get_value() -> DeleteBackendStorageResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "JobId": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteBackendStorageResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteTokenResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import DeleteTokenResponseTypeDef

def get_value() -> DeleteTokenResponseTypeDef:
    return {
        "IsSuccess": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteTokenResponseTypeDef(TypedDict):
    IsSuccess: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GenerateBackendAPIModelsResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GenerateBackendAPIModelsResponseTypeDef

def get_value() -> GenerateBackendAPIModelsResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "Error": ...,
        "JobId": ...,
        "Operation": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class GenerateBackendAPIModelsResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetBackendAPIModelsResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetBackendAPIModelsResponseTypeDef

def get_value() -> GetBackendAPIModelsResponseTypeDef:
    return {
        "Models": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetBackendAPIModelsResponseTypeDef(TypedDict):
    Models: str,
    Status: StatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StatusType
  2. See ResponseMetadataTypeDef

GetBackendJobResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetBackendJobResponseTypeDef

def get_value() -> GetBackendJobResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "CreateTime": ...,
        "Error": ...,
        "JobId": ...,
        "Operation": ...,
        "Status": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetBackendJobResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    CreateTime: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    UpdateTime: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetBackendResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetBackendResponseTypeDef

def get_value() -> GetBackendResponseTypeDef:
    return {
        "AmplifyFeatureFlags": ...,
        "AmplifyMetaConfig": ...,
        "AppId": ...,
        "AppName": ...,
        "BackendEnvironmentList": ...,
        "BackendEnvironmentName": ...,
        "Error": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetBackendResponseTypeDef(TypedDict):
    AmplifyFeatureFlags: str,
    AmplifyMetaConfig: str,
    AppId: str,
    AppName: str,
    BackendEnvironmentList: List[str],
    BackendEnvironmentName: str,
    Error: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetTokenResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetTokenResponseTypeDef

def get_value() -> GetTokenResponseTypeDef:
    return {
        "AppId": ...,
        "ChallengeCode": ...,
        "SessionId": ...,
        "Ttl": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetTokenResponseTypeDef(TypedDict):
    AppId: str,
    ChallengeCode: str,
    SessionId: str,
    Ttl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ImportBackendAuthResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import ImportBackendAuthResponseTypeDef

def get_value() -> ImportBackendAuthResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "Error": ...,
        "JobId": ...,
        "Operation": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class ImportBackendAuthResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ImportBackendStorageResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import ImportBackendStorageResponseTypeDef

def get_value() -> ImportBackendStorageResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "JobId": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class ImportBackendStorageResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListBackendJobsResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import ListBackendJobsResponseTypeDef

def get_value() -> ListBackendJobsResponseTypeDef:
    return {
        "Jobs": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListBackendJobsResponseTypeDef(TypedDict):
    Jobs: List[BackendJobRespObjTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackendJobRespObjTypeDef
  2. See ResponseMetadataTypeDef

RemoveAllBackendsResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import RemoveAllBackendsResponseTypeDef

def get_value() -> RemoveAllBackendsResponseTypeDef:
    return {
        "AppId": ...,
        "Error": ...,
        "JobId": ...,
        "Operation": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class RemoveAllBackendsResponseTypeDef(TypedDict):
    AppId: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RemoveBackendConfigResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import RemoveBackendConfigResponseTypeDef

def get_value() -> RemoveBackendConfigResponseTypeDef:
    return {
        "Error": ...,
        "ResponseMetadata": ...,
    }
Definition
class RemoveBackendConfigResponseTypeDef(TypedDict):
    Error: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateBackendAPIResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAPIResponseTypeDef

def get_value() -> UpdateBackendAPIResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "Error": ...,
        "JobId": ...,
        "Operation": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateBackendAPIResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateBackendAuthResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthResponseTypeDef

def get_value() -> UpdateBackendAuthResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "Error": ...,
        "JobId": ...,
        "Operation": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateBackendAuthResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateBackendJobResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendJobResponseTypeDef

def get_value() -> UpdateBackendJobResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "CreateTime": ...,
        "Error": ...,
        "JobId": ...,
        "Operation": ...,
        "Status": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateBackendJobResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    CreateTime: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    UpdateTime: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateBackendStorageResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendStorageResponseTypeDef

def get_value() -> UpdateBackendStorageResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "JobId": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateBackendStorageResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBackendAuthForgotPasswordConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthForgotPasswordConfigTypeDef

def get_value() -> CreateBackendAuthForgotPasswordConfigTypeDef:
    return {
        "DeliveryMethod": ...,
    }
Definition
class CreateBackendAuthForgotPasswordConfigTypeDef(TypedDict):
    DeliveryMethod: DeliveryMethodType,  # (1)
    EmailSettings: NotRequired[EmailSettingsTypeDef],  # (2)
    SmsSettings: NotRequired[SmsSettingsTypeDef],  # (3)
  1. See DeliveryMethodType
  2. See EmailSettingsTypeDef
  3. See SmsSettingsTypeDef

CreateBackendAuthVerificationMessageConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthVerificationMessageConfigTypeDef

def get_value() -> CreateBackendAuthVerificationMessageConfigTypeDef:
    return {
        "DeliveryMethod": ...,
    }
Definition
class CreateBackendAuthVerificationMessageConfigTypeDef(TypedDict):
    DeliveryMethod: DeliveryMethodType,  # (1)
    EmailSettings: NotRequired[EmailSettingsTypeDef],  # (2)
    SmsSettings: NotRequired[SmsSettingsTypeDef],  # (3)
  1. See DeliveryMethodType
  2. See EmailSettingsTypeDef
  3. See SmsSettingsTypeDef

UpdateBackendAuthForgotPasswordConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthForgotPasswordConfigTypeDef

def get_value() -> UpdateBackendAuthForgotPasswordConfigTypeDef:
    return {
        "DeliveryMethod": ...,
    }
Definition
class UpdateBackendAuthForgotPasswordConfigTypeDef(TypedDict):
    DeliveryMethod: NotRequired[DeliveryMethodType],  # (1)
    EmailSettings: NotRequired[EmailSettingsTypeDef],  # (2)
    SmsSettings: NotRequired[SmsSettingsTypeDef],  # (3)
  1. See DeliveryMethodType
  2. See EmailSettingsTypeDef
  3. See SmsSettingsTypeDef

UpdateBackendAuthVerificationMessageConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthVerificationMessageConfigTypeDef

def get_value() -> UpdateBackendAuthVerificationMessageConfigTypeDef:
    return {
        "DeliveryMethod": ...,
    }
Definition
class UpdateBackendAuthVerificationMessageConfigTypeDef(TypedDict):
    DeliveryMethod: DeliveryMethodType,  # (1)
    EmailSettings: NotRequired[EmailSettingsTypeDef],  # (2)
    SmsSettings: NotRequired[SmsSettingsTypeDef],  # (3)
  1. See DeliveryMethodType
  2. See EmailSettingsTypeDef
  3. See SmsSettingsTypeDef

CreateBackendAuthMFAConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthMFAConfigTypeDef

def get_value() -> CreateBackendAuthMFAConfigTypeDef:
    return {
        "MFAMode": ...,
    }
Definition
class CreateBackendAuthMFAConfigTypeDef(TypedDict):
    MFAMode: MFAModeType,  # (1)
    Settings: NotRequired[SettingsTypeDef],  # (2)
  1. See MFAModeType
  2. See SettingsTypeDef

UpdateBackendAuthMFAConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthMFAConfigTypeDef

def get_value() -> UpdateBackendAuthMFAConfigTypeDef:
    return {
        "MFAMode": ...,
    }
Definition
class UpdateBackendAuthMFAConfigTypeDef(TypedDict):
    MFAMode: NotRequired[MFAModeType],  # (1)
    Settings: NotRequired[SettingsTypeDef],  # (2)
  1. See MFAModeType
  2. See SettingsTypeDef

ListBackendJobsRequestListBackendJobsPaginateTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import ListBackendJobsRequestListBackendJobsPaginateTypeDef

def get_value() -> ListBackendJobsRequestListBackendJobsPaginateTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
    }
Definition
class ListBackendJobsRequestListBackendJobsPaginateTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: NotRequired[str],
    Operation: NotRequired[str],
    Status: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListS3BucketsResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import ListS3BucketsResponseTypeDef

def get_value() -> ListS3BucketsResponseTypeDef:
    return {
        "Buckets": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListS3BucketsResponseTypeDef(TypedDict):
    Buckets: List[S3BucketInfoTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See S3BucketInfoTypeDef
  2. See ResponseMetadataTypeDef

UpdateBackendConfigRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendConfigRequestRequestTypeDef

def get_value() -> UpdateBackendConfigRequestRequestTypeDef:
    return {
        "AppId": ...,
    }
Definition
class UpdateBackendConfigRequestRequestTypeDef(TypedDict):
    AppId: str,
    LoginAuthConfig: NotRequired[LoginAuthConfigReqObjTypeDef],  # (1)
  1. See LoginAuthConfigReqObjTypeDef

UpdateBackendConfigResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendConfigResponseTypeDef

def get_value() -> UpdateBackendConfigResponseTypeDef:
    return {
        "AppId": ...,
        "BackendManagerAppId": ...,
        "Error": ...,
        "LoginAuthConfig": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateBackendConfigResponseTypeDef(TypedDict):
    AppId: str,
    BackendManagerAppId: str,
    Error: str,
    LoginAuthConfig: LoginAuthConfigReqObjTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoginAuthConfigReqObjTypeDef
  2. See ResponseMetadataTypeDef

BackendAPIResourceConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import BackendAPIResourceConfigTypeDef

def get_value() -> BackendAPIResourceConfigTypeDef:
    return {
        "AdditionalAuthTypes": ...,
    }
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],
  1. See BackendAPIAuthTypeTypeDef
  2. See BackendAPIConflictResolutionTypeDef
  3. See BackendAPIAuthTypeTypeDef

CreateBackendAuthOAuthConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthOAuthConfigTypeDef

def get_value() -> CreateBackendAuthOAuthConfigTypeDef:
    return {
        "OAuthGrantType": ...,
        "OAuthScopes": ...,
        "RedirectSignInURIs": ...,
        "RedirectSignOutURIs": ...,
    }
Definition
class CreateBackendAuthOAuthConfigTypeDef(TypedDict):
    OAuthGrantType: OAuthGrantTypeType,  # (1)
    OAuthScopes: Sequence[OAuthScopesElementType],  # (2)
    RedirectSignInURIs: Sequence[str],
    RedirectSignOutURIs: Sequence[str],
    DomainPrefix: NotRequired[str],
    SocialProviderSettings: NotRequired[SocialProviderSettingsTypeDef],  # (3)
  1. See OAuthGrantTypeType
  2. See OAuthScopesElementType
  3. See SocialProviderSettingsTypeDef

UpdateBackendAuthOAuthConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthOAuthConfigTypeDef

def get_value() -> UpdateBackendAuthOAuthConfigTypeDef:
    return {
        "DomainPrefix": ...,
    }
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)
  1. See OAuthGrantTypeType
  2. See OAuthScopesElementType
  3. See SocialProviderSettingsTypeDef

CreateBackendStorageRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendStorageRequestRequestTypeDef

def get_value() -> CreateBackendStorageRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceConfig": ...,
        "ResourceName": ...,
    }
Definition
class CreateBackendStorageRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: CreateBackendStorageResourceConfigTypeDef,  # (1)
    ResourceName: str,
  1. See CreateBackendStorageResourceConfigTypeDef

GetBackendStorageResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetBackendStorageResponseTypeDef

def get_value() -> GetBackendStorageResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceConfig": ...,
        "ResourceName": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetBackendStorageResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: GetBackendStorageResourceConfigTypeDef,  # (1)
    ResourceName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GetBackendStorageResourceConfigTypeDef
  2. See ResponseMetadataTypeDef

UpdateBackendStorageRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendStorageRequestRequestTypeDef

def get_value() -> UpdateBackendStorageRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceConfig": ...,
        "ResourceName": ...,
    }
Definition
class UpdateBackendStorageRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: UpdateBackendStorageResourceConfigTypeDef,  # (1)
    ResourceName: str,
  1. See UpdateBackendStorageResourceConfigTypeDef

CreateBackendAPIRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAPIRequestRequestTypeDef

def get_value() -> CreateBackendAPIRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceConfig": ...,
        "ResourceName": ...,
    }
Definition
class CreateBackendAPIRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: BackendAPIResourceConfigTypeDef,  # (1)
    ResourceName: str,
  1. See BackendAPIResourceConfigTypeDef

DeleteBackendAPIRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import DeleteBackendAPIRequestRequestTypeDef

def get_value() -> DeleteBackendAPIRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceName": ...,
    }
Definition
class DeleteBackendAPIRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
    ResourceConfig: NotRequired[BackendAPIResourceConfigTypeDef],  # (1)
  1. See BackendAPIResourceConfigTypeDef

GetBackendAPIRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetBackendAPIRequestRequestTypeDef

def get_value() -> GetBackendAPIRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceName": ...,
    }
Definition
class GetBackendAPIRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
    ResourceConfig: NotRequired[BackendAPIResourceConfigTypeDef],  # (1)
  1. See BackendAPIResourceConfigTypeDef

GetBackendAPIResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetBackendAPIResponseTypeDef

def get_value() -> GetBackendAPIResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "Error": ...,
        "ResourceConfig": ...,
        "ResourceName": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetBackendAPIResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    ResourceConfig: BackendAPIResourceConfigTypeDef,  # (1)
    ResourceName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackendAPIResourceConfigTypeDef
  2. See ResponseMetadataTypeDef

UpdateBackendAPIRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAPIRequestRequestTypeDef

def get_value() -> UpdateBackendAPIRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceName": ...,
    }
Definition
class UpdateBackendAPIRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
    ResourceConfig: NotRequired[BackendAPIResourceConfigTypeDef],  # (1)
  1. See BackendAPIResourceConfigTypeDef

CreateBackendAuthUserPoolConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthUserPoolConfigTypeDef

def get_value() -> CreateBackendAuthUserPoolConfigTypeDef:
    return {
        "RequiredSignUpAttributes": ...,
        "SignInMethod": ...,
        "UserPoolName": ...,
    }
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)
  1. See CreateBackendAuthForgotPasswordConfigTypeDef
  2. See CreateBackendAuthMFAConfigTypeDef
  3. See CreateBackendAuthOAuthConfigTypeDef
  4. See CreateBackendAuthPasswordPolicyConfigTypeDef
  5. See RequiredSignUpAttributesElementType
  6. See SignInMethodType
  7. See CreateBackendAuthVerificationMessageConfigTypeDef

UpdateBackendAuthUserPoolConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthUserPoolConfigTypeDef

def get_value() -> UpdateBackendAuthUserPoolConfigTypeDef:
    return {
        "ForgotPassword": ...,
    }
Definition
class UpdateBackendAuthUserPoolConfigTypeDef(TypedDict):
    ForgotPassword: NotRequired[UpdateBackendAuthForgotPasswordConfigTypeDef],  # (1)
    Mfa: NotRequired[UpdateBackendAuthMFAConfigTypeDef],  # (2)
    OAuth: NotRequired[UpdateBackendAuthOAuthConfigTypeDef],  # (3)
    PasswordPolicy: NotRequired[UpdateBackendAuthPasswordPolicyConfigTypeDef],  # (4)
    VerificationMessage: NotRequired[UpdateBackendAuthVerificationMessageConfigTypeDef],  # (5)
  1. See UpdateBackendAuthForgotPasswordConfigTypeDef
  2. See UpdateBackendAuthMFAConfigTypeDef
  3. See UpdateBackendAuthOAuthConfigTypeDef
  4. See UpdateBackendAuthPasswordPolicyConfigTypeDef
  5. See UpdateBackendAuthVerificationMessageConfigTypeDef

CreateBackendAuthResourceConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthResourceConfigTypeDef

def get_value() -> CreateBackendAuthResourceConfigTypeDef:
    return {
        "AuthResources": ...,
        "Service": ...,
        "UserPoolConfigs": ...,
    }
Definition
class CreateBackendAuthResourceConfigTypeDef(TypedDict):
    AuthResources: AuthResourcesType,  # (1)
    Service: ServiceType,  # (3)
    UserPoolConfigs: CreateBackendAuthUserPoolConfigTypeDef,  # (4)
    IdentityPoolConfigs: NotRequired[CreateBackendAuthIdentityPoolConfigTypeDef],  # (2)
  1. See AuthResourcesType
  2. See CreateBackendAuthIdentityPoolConfigTypeDef
  3. See ServiceType
  4. See CreateBackendAuthUserPoolConfigTypeDef

UpdateBackendAuthResourceConfigTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthResourceConfigTypeDef

def get_value() -> UpdateBackendAuthResourceConfigTypeDef:
    return {
        "AuthResources": ...,
        "Service": ...,
        "UserPoolConfigs": ...,
    }
Definition
class UpdateBackendAuthResourceConfigTypeDef(TypedDict):
    AuthResources: AuthResourcesType,  # (1)
    Service: ServiceType,  # (3)
    UserPoolConfigs: UpdateBackendAuthUserPoolConfigTypeDef,  # (4)
    IdentityPoolConfigs: NotRequired[UpdateBackendAuthIdentityPoolConfigTypeDef],  # (2)
  1. See AuthResourcesType
  2. See UpdateBackendAuthIdentityPoolConfigTypeDef
  3. See ServiceType
  4. See UpdateBackendAuthUserPoolConfigTypeDef

CreateBackendAuthRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import CreateBackendAuthRequestRequestTypeDef

def get_value() -> CreateBackendAuthRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceConfig": ...,
        "ResourceName": ...,
    }
Definition
class CreateBackendAuthRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: CreateBackendAuthResourceConfigTypeDef,  # (1)
    ResourceName: str,
  1. See CreateBackendAuthResourceConfigTypeDef

GetBackendAuthResponseTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import GetBackendAuthResponseTypeDef

def get_value() -> GetBackendAuthResponseTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "Error": ...,
        "ResourceConfig": ...,
        "ResourceName": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetBackendAuthResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    ResourceConfig: CreateBackendAuthResourceConfigTypeDef,  # (1)
    ResourceName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CreateBackendAuthResourceConfigTypeDef
  2. See ResponseMetadataTypeDef

UpdateBackendAuthRequestRequestTypeDef

Usage Example
from mypy_boto3_amplifybackend.type_defs import UpdateBackendAuthRequestRequestTypeDef

def get_value() -> UpdateBackendAuthRequestRequestTypeDef:
    return {
        "AppId": ...,
        "BackendEnvironmentName": ...,
        "ResourceConfig": ...,
        "ResourceName": ...,
    }
Definition
class UpdateBackendAuthRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: UpdateBackendAuthResourceConfigTypeDef,  # (1)
    ResourceName: str,
  1. See UpdateBackendAuthResourceConfigTypeDef