Skip to content

Type definitions#

Index > AmplifyBackend > Type definitions

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

BackendStoragePermissionsUnionTypeDef#

# BackendStoragePermissionsUnionTypeDef definition

BackendStoragePermissionsUnionTypeDef = Union[
    BackendStoragePermissionsTypeDef,  # (1)
    BackendStoragePermissionsOutputTypeDef,  # (2)
]
  1. See BackendStoragePermissionsTypeDef
  2. See BackendStoragePermissionsOutputTypeDef

CreateBackendAuthPasswordPolicyConfigUnionTypeDef#

# CreateBackendAuthPasswordPolicyConfigUnionTypeDef definition

CreateBackendAuthPasswordPolicyConfigUnionTypeDef = Union[
    CreateBackendAuthPasswordPolicyConfigTypeDef,  # (1)
    CreateBackendAuthPasswordPolicyConfigOutputTypeDef,  # (2)
]
  1. See CreateBackendAuthPasswordPolicyConfigTypeDef
  2. See CreateBackendAuthPasswordPolicyConfigOutputTypeDef

SettingsUnionTypeDef#

# SettingsUnionTypeDef definition

SettingsUnionTypeDef = Union[
    SettingsTypeDef,  # (1)
    SettingsOutputTypeDef,  # (2)
]
  1. See SettingsTypeDef
  2. See SettingsOutputTypeDef

CreateBackendAuthOAuthConfigUnionTypeDef#

# CreateBackendAuthOAuthConfigUnionTypeDef definition

CreateBackendAuthOAuthConfigUnionTypeDef = Union[
    CreateBackendAuthOAuthConfigTypeDef,  # (1)
    CreateBackendAuthOAuthConfigOutputTypeDef,  # (2)
]
  1. See CreateBackendAuthOAuthConfigTypeDef
  2. See CreateBackendAuthOAuthConfigOutputTypeDef

CreateBackendAuthMFAConfigUnionTypeDef#

# CreateBackendAuthMFAConfigUnionTypeDef definition

CreateBackendAuthMFAConfigUnionTypeDef = Union[
    CreateBackendAuthMFAConfigTypeDef,  # (1)
    CreateBackendAuthMFAConfigOutputTypeDef,  # (2)
]
  1. See CreateBackendAuthMFAConfigTypeDef
  2. See CreateBackendAuthMFAConfigOutputTypeDef

CreateBackendAuthUserPoolConfigUnionTypeDef#

# CreateBackendAuthUserPoolConfigUnionTypeDef definition

CreateBackendAuthUserPoolConfigUnionTypeDef = Union[
    CreateBackendAuthUserPoolConfigTypeDef,  # (1)
    CreateBackendAuthUserPoolConfigOutputTypeDef,  # (2)
]
  1. See CreateBackendAuthUserPoolConfigTypeDef
  2. See CreateBackendAuthUserPoolConfigOutputTypeDef

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)
  1. See ResolutionStrategyType

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],

BackendStoragePermissionsOutputTypeDef#

# BackendStoragePermissionsOutputTypeDef definition

class BackendStoragePermissionsOutputTypeDef(TypedDict):
    Authenticated: list[AuthenticatedElementType],  # (1)
    UnAuthenticated: NotRequired[list[UnAuthenticatedElementType]],  # (2)
  1. See AuthenticatedElementType
  2. See UnAuthenticatedElementType

BackendStoragePermissionsTypeDef#

# BackendStoragePermissionsTypeDef definition

class BackendStoragePermissionsTypeDef(TypedDict):
    Authenticated: Sequence[AuthenticatedElementType],  # (1)
    UnAuthenticated: NotRequired[Sequence[UnAuthenticatedElementType]],  # (2)
  1. See AuthenticatedElementType
  2. See UnAuthenticatedElementType

CloneBackendRequestRequestTypeDef#

# CloneBackendRequestRequestTypeDef definition

class CloneBackendRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    TargetEnvironmentName: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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,

SettingsOutputTypeDef#

# SettingsOutputTypeDef definition

class SettingsOutputTypeDef(TypedDict):
    MfaTypes: NotRequired[list[MfaTypesElementType]],  # (1)
    SmsMessage: NotRequired[str],
  1. See MfaTypesElementType

CreateBackendAuthPasswordPolicyConfigOutputTypeDef#

# CreateBackendAuthPasswordPolicyConfigOutputTypeDef definition

class CreateBackendAuthPasswordPolicyConfigOutputTypeDef(TypedDict):
    MinimumLength: float,
    AdditionalConstraints: NotRequired[list[AdditionalConstraintsElementType]],  # (1)
  1. See AdditionalConstraintsElementType

CreateBackendAuthPasswordPolicyConfigTypeDef#

# CreateBackendAuthPasswordPolicyConfigTypeDef definition

class CreateBackendAuthPasswordPolicyConfigTypeDef(TypedDict):
    MinimumLength: float,
    AdditionalConstraints: NotRequired[Sequence[AdditionalConstraintsElementType]],  # (1)
  1. See AdditionalConstraintsElementType

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)
  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],
  1. 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,

SettingsTypeDef#

# SettingsTypeDef definition

class SettingsTypeDef(TypedDict):
    MfaTypes: NotRequired[Sequence[MfaTypesElementType]],  # (1)
    SmsMessage: NotRequired[str],
  1. See MfaTypesElementType

UpdateBackendAuthIdentityPoolConfigTypeDef#

# UpdateBackendAuthIdentityPoolConfigTypeDef definition

class UpdateBackendAuthIdentityPoolConfigTypeDef(TypedDict):
    UnauthenticatedLogin: NotRequired[bool],

UpdateBackendAuthPasswordPolicyConfigTypeDef#

# UpdateBackendAuthPasswordPolicyConfigTypeDef definition

class UpdateBackendAuthPasswordPolicyConfigTypeDef(TypedDict):
    AdditionalConstraints: NotRequired[Sequence[AdditionalConstraintsElementType]],  # (1)
    MinimumLength: NotRequired[float],
  1. See AdditionalConstraintsElementType

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)
  1. See ModeType
  2. See BackendAPIAppSyncAuthSettingsTypeDef

SocialProviderSettingsTypeDef#

# SocialProviderSettingsTypeDef 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

GetBackendStorageResourceConfigTypeDef#

# GetBackendStorageResourceConfigTypeDef definition

class GetBackendStorageResourceConfigTypeDef(TypedDict):
    Imported: bool,
    ServiceName: ServiceNameType,  # (2)
    BucketName: NotRequired[str],
    Permissions: NotRequired[BackendStoragePermissionsOutputTypeDef],  # (1)
  1. See BackendStoragePermissionsOutputTypeDef
  2. See ServiceNameType

CloneBackendResponseTypeDef#

# CloneBackendResponseTypeDef definition

class CloneBackendResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBackendAPIResponseTypeDef#

# CreateBackendAPIResponseTypeDef definition

class CreateBackendAPIResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBackendAuthResponseTypeDef#

# CreateBackendAuthResponseTypeDef definition

class CreateBackendAuthResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBackendConfigResponseTypeDef#

# CreateBackendConfigResponseTypeDef definition

class CreateBackendConfigResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBackendResponseTypeDef#

# CreateBackendResponseTypeDef definition

class CreateBackendResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBackendStorageResponseTypeDef#

# CreateBackendStorageResponseTypeDef definition

class CreateBackendStorageResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTokenResponseTypeDef#

# CreateTokenResponseTypeDef definition

class CreateTokenResponseTypeDef(TypedDict):
    AppId: str,
    ChallengeCode: str,
    SessionId: str,
    Ttl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteBackendAPIResponseTypeDef#

# DeleteBackendAPIResponseTypeDef definition

class DeleteBackendAPIResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteBackendAuthResponseTypeDef#

# DeleteBackendAuthResponseTypeDef definition

class DeleteBackendAuthResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteBackendResponseTypeDef#

# DeleteBackendResponseTypeDef definition

class DeleteBackendResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteBackendStorageResponseTypeDef#

# DeleteBackendStorageResponseTypeDef definition

class DeleteBackendStorageResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteTokenResponseTypeDef#

# DeleteTokenResponseTypeDef definition

class DeleteTokenResponseTypeDef(TypedDict):
    IsSuccess: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GenerateBackendAPIModelsResponseTypeDef#

# GenerateBackendAPIModelsResponseTypeDef definition

class GenerateBackendAPIModelsResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetBackendAPIModelsResponseTypeDef#

# GetBackendAPIModelsResponseTypeDef definition

class GetBackendAPIModelsResponseTypeDef(TypedDict):
    Models: str,
    Status: StatusType,  # (1)
    ModelIntrospectionSchema: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StatusType
  2. 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)
  1. See ResponseMetadataTypeDef

GetBackendResponseTypeDef#

# GetBackendResponseTypeDef 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#

# GetTokenResponseTypeDef definition

class GetTokenResponseTypeDef(TypedDict):
    AppId: str,
    ChallengeCode: str,
    SessionId: str,
    Ttl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ImportBackendAuthResponseTypeDef#

# ImportBackendAuthResponseTypeDef definition

class ImportBackendAuthResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ImportBackendStorageResponseTypeDef#

# ImportBackendStorageResponseTypeDef definition

class ImportBackendStorageResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListBackendJobsResponseTypeDef#

# ListBackendJobsResponseTypeDef definition

class ListBackendJobsResponseTypeDef(TypedDict):
    Jobs: list[BackendJobRespObjTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See BackendJobRespObjTypeDef
  2. See ResponseMetadataTypeDef

RemoveAllBackendsResponseTypeDef#

# RemoveAllBackendsResponseTypeDef definition

class RemoveAllBackendsResponseTypeDef(TypedDict):
    AppId: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RemoveBackendConfigResponseTypeDef#

# RemoveBackendConfigResponseTypeDef definition

class RemoveBackendConfigResponseTypeDef(TypedDict):
    Error: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateBackendAPIResponseTypeDef#

# UpdateBackendAPIResponseTypeDef definition

class UpdateBackendAPIResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateBackendAuthResponseTypeDef#

# UpdateBackendAuthResponseTypeDef definition

class UpdateBackendAuthResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    JobId: str,
    Operation: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

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)
  1. See ResponseMetadataTypeDef

UpdateBackendStorageResponseTypeDef#

# UpdateBackendStorageResponseTypeDef definition

class UpdateBackendStorageResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,
    Status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBackendAuthForgotPasswordConfigTypeDef#

# CreateBackendAuthForgotPasswordConfigTypeDef 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#

# CreateBackendAuthVerificationMessageConfigTypeDef 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#

# UpdateBackendAuthForgotPasswordConfigTypeDef 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#

# UpdateBackendAuthVerificationMessageConfigTypeDef definition

class UpdateBackendAuthVerificationMessageConfigTypeDef(TypedDict):
    DeliveryMethod: DeliveryMethodType,  # (1)
    EmailSettings: NotRequired[EmailSettingsTypeDef],  # (2)
    SmsSettings: NotRequired[SmsSettingsTypeDef],  # (3)
  1. See DeliveryMethodType
  2. See EmailSettingsTypeDef
  3. See SmsSettingsTypeDef

CreateBackendAuthMFAConfigOutputTypeDef#

# CreateBackendAuthMFAConfigOutputTypeDef definition

class CreateBackendAuthMFAConfigOutputTypeDef(TypedDict):
    MFAMode: MFAModeType,  # (1)
    Settings: NotRequired[SettingsOutputTypeDef],  # (2)
  1. See MFAModeType
  2. See SettingsOutputTypeDef

ListBackendJobsRequestPaginateTypeDef#

# ListBackendJobsRequestPaginateTypeDef definition

class ListBackendJobsRequestPaginateTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    JobId: NotRequired[str],
    Operation: NotRequired[str],
    Status: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListS3BucketsResponseTypeDef#

# ListS3BucketsResponseTypeDef definition

class ListS3BucketsResponseTypeDef(TypedDict):
    Buckets: list[S3BucketInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See S3BucketInfoTypeDef
  2. See ResponseMetadataTypeDef

UpdateBackendConfigRequestRequestTypeDef#

# UpdateBackendConfigRequestRequestTypeDef definition

class UpdateBackendConfigRequestRequestTypeDef(TypedDict):
    AppId: str,
    LoginAuthConfig: NotRequired[LoginAuthConfigReqObjTypeDef],  # (1)
  1. See LoginAuthConfigReqObjTypeDef

UpdateBackendConfigResponseTypeDef#

# UpdateBackendConfigResponseTypeDef definition

class UpdateBackendConfigResponseTypeDef(TypedDict):
    AppId: str,
    BackendManagerAppId: str,
    Error: str,
    LoginAuthConfig: LoginAuthConfigReqObjTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoginAuthConfigReqObjTypeDef
  2. See ResponseMetadataTypeDef

BackendAPIResourceConfigOutputTypeDef#

# 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],
  1. See BackendAPIAuthTypeTypeDef
  2. See BackendAPIConflictResolutionTypeDef
  3. See BackendAPIAuthTypeTypeDef

BackendAPIResourceConfigTypeDef#

# 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],
  1. See BackendAPIAuthTypeTypeDef
  2. See BackendAPIConflictResolutionTypeDef
  3. See BackendAPIAuthTypeTypeDef

CreateBackendAuthOAuthConfigOutputTypeDef#

# 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)
  1. See OAuthGrantTypeType
  2. See OAuthScopesElementType
  3. See SocialProviderSettingsTypeDef

CreateBackendAuthOAuthConfigTypeDef#

# 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)
  1. See OAuthGrantTypeType
  2. See OAuthScopesElementType
  3. See SocialProviderSettingsTypeDef

UpdateBackendAuthOAuthConfigTypeDef#

# 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)
  1. See OAuthGrantTypeType
  2. See OAuthScopesElementType
  3. See SocialProviderSettingsTypeDef

GetBackendStorageResponseTypeDef#

# GetBackendStorageResponseTypeDef definition

class GetBackendStorageResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: GetBackendStorageResourceConfigTypeDef,  # (1)
    ResourceName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GetBackendStorageResourceConfigTypeDef
  2. See ResponseMetadataTypeDef

CreateBackendStorageResourceConfigTypeDef#

# CreateBackendStorageResourceConfigTypeDef definition

class CreateBackendStorageResourceConfigTypeDef(TypedDict):
    Permissions: BackendStoragePermissionsUnionTypeDef,  # (1)
    ServiceName: ServiceNameType,  # (2)
    BucketName: NotRequired[str],
  1. See BackendStoragePermissionsTypeDef BackendStoragePermissionsOutputTypeDef
  2. See ServiceNameType

UpdateBackendStorageResourceConfigTypeDef#

# UpdateBackendStorageResourceConfigTypeDef definition

class UpdateBackendStorageResourceConfigTypeDef(TypedDict):
    Permissions: BackendStoragePermissionsUnionTypeDef,  # (1)
    ServiceName: ServiceNameType,  # (2)
  1. See BackendStoragePermissionsTypeDef BackendStoragePermissionsOutputTypeDef
  2. See ServiceNameType

CreateBackendAuthMFAConfigTypeDef#

# CreateBackendAuthMFAConfigTypeDef definition

class CreateBackendAuthMFAConfigTypeDef(TypedDict):
    MFAMode: MFAModeType,  # (1)
    Settings: NotRequired[SettingsUnionTypeDef],  # (2)
  1. See MFAModeType
  2. See SettingsTypeDef SettingsOutputTypeDef

UpdateBackendAuthMFAConfigTypeDef#

# UpdateBackendAuthMFAConfigTypeDef definition

class UpdateBackendAuthMFAConfigTypeDef(TypedDict):
    MFAMode: NotRequired[MFAModeType],  # (1)
    Settings: NotRequired[SettingsUnionTypeDef],  # (2)
  1. See MFAModeType
  2. See SettingsTypeDef SettingsOutputTypeDef

GetBackendAPIResponseTypeDef#

# GetBackendAPIResponseTypeDef definition

class GetBackendAPIResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    ResourceConfig: BackendAPIResourceConfigOutputTypeDef,  # (1)
    ResourceName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackendAPIResourceConfigOutputTypeDef
  2. See ResponseMetadataTypeDef

CreateBackendAPIRequestRequestTypeDef#

# CreateBackendAPIRequestRequestTypeDef definition

class CreateBackendAPIRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: BackendAPIResourceConfigTypeDef,  # (1)
    ResourceName: str,
  1. See BackendAPIResourceConfigTypeDef

DeleteBackendAPIRequestRequestTypeDef#

# DeleteBackendAPIRequestRequestTypeDef definition

class DeleteBackendAPIRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
    ResourceConfig: NotRequired[BackendAPIResourceConfigTypeDef],  # (1)
  1. See BackendAPIResourceConfigTypeDef

GetBackendAPIRequestRequestTypeDef#

# GetBackendAPIRequestRequestTypeDef definition

class GetBackendAPIRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
    ResourceConfig: NotRequired[BackendAPIResourceConfigTypeDef],  # (1)
  1. See BackendAPIResourceConfigTypeDef

UpdateBackendAPIRequestRequestTypeDef#

# UpdateBackendAPIRequestRequestTypeDef definition

class UpdateBackendAPIRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
    ResourceConfig: NotRequired[BackendAPIResourceConfigTypeDef],  # (1)
  1. See BackendAPIResourceConfigTypeDef

CreateBackendAuthUserPoolConfigOutputTypeDef#

# 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)
  1. See CreateBackendAuthForgotPasswordConfigTypeDef
  2. See CreateBackendAuthMFAConfigOutputTypeDef
  3. See CreateBackendAuthOAuthConfigOutputTypeDef
  4. See CreateBackendAuthPasswordPolicyConfigOutputTypeDef
  5. See RequiredSignUpAttributesElementType
  6. See SignInMethodType
  7. See CreateBackendAuthVerificationMessageConfigTypeDef

CreateBackendStorageRequestRequestTypeDef#

# CreateBackendStorageRequestRequestTypeDef definition

class CreateBackendStorageRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: CreateBackendStorageResourceConfigTypeDef,  # (1)
    ResourceName: str,
  1. See CreateBackendStorageResourceConfigTypeDef

UpdateBackendStorageRequestRequestTypeDef#

# UpdateBackendStorageRequestRequestTypeDef definition

class UpdateBackendStorageRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: UpdateBackendStorageResourceConfigTypeDef,  # (1)
    ResourceName: str,
  1. See UpdateBackendStorageResourceConfigTypeDef

UpdateBackendAuthUserPoolConfigTypeDef#

# 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)
  1. See UpdateBackendAuthForgotPasswordConfigTypeDef
  2. See UpdateBackendAuthMFAConfigTypeDef
  3. See UpdateBackendAuthOAuthConfigTypeDef
  4. See UpdateBackendAuthPasswordPolicyConfigTypeDef
  5. See UpdateBackendAuthVerificationMessageConfigTypeDef

CreateBackendAuthResourceConfigOutputTypeDef#

# CreateBackendAuthResourceConfigOutputTypeDef definition

class CreateBackendAuthResourceConfigOutputTypeDef(TypedDict):
    AuthResources: AuthResourcesType,  # (1)
    Service: ServiceType,  # (3)
    UserPoolConfigs: CreateBackendAuthUserPoolConfigOutputTypeDef,  # (4)
    IdentityPoolConfigs: NotRequired[CreateBackendAuthIdentityPoolConfigTypeDef],  # (2)
  1. See AuthResourcesType
  2. See CreateBackendAuthIdentityPoolConfigTypeDef
  3. See ServiceType
  4. See CreateBackendAuthUserPoolConfigOutputTypeDef

CreateBackendAuthUserPoolConfigTypeDef#

# CreateBackendAuthUserPoolConfigTypeDef definition

class CreateBackendAuthUserPoolConfigTypeDef(TypedDict):
    RequiredSignUpAttributes: Sequence[RequiredSignUpAttributesElementType],  # (5)
    SignInMethod: SignInMethodType,  # (6)
    UserPoolName: str,
    ForgotPassword: NotRequired[CreateBackendAuthForgotPasswordConfigTypeDef],  # (1)
    Mfa: NotRequired[CreateBackendAuthMFAConfigUnionTypeDef],  # (2)
    OAuth: NotRequired[CreateBackendAuthOAuthConfigUnionTypeDef],  # (3)
    PasswordPolicy: NotRequired[CreateBackendAuthPasswordPolicyConfigUnionTypeDef],  # (4)
    VerificationMessage: NotRequired[CreateBackendAuthVerificationMessageConfigTypeDef],  # (7)
  1. See CreateBackendAuthForgotPasswordConfigTypeDef
  2. See CreateBackendAuthMFAConfigTypeDef CreateBackendAuthMFAConfigOutputTypeDef
  3. See CreateBackendAuthOAuthConfigTypeDef CreateBackendAuthOAuthConfigOutputTypeDef
  4. See CreateBackendAuthPasswordPolicyConfigTypeDef CreateBackendAuthPasswordPolicyConfigOutputTypeDef
  5. See RequiredSignUpAttributesElementType
  6. See SignInMethodType
  7. See CreateBackendAuthVerificationMessageConfigTypeDef

UpdateBackendAuthResourceConfigTypeDef#

# UpdateBackendAuthResourceConfigTypeDef 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

GetBackendAuthResponseTypeDef#

# GetBackendAuthResponseTypeDef definition

class GetBackendAuthResponseTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    Error: str,
    ResourceConfig: CreateBackendAuthResourceConfigOutputTypeDef,  # (1)
    ResourceName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CreateBackendAuthResourceConfigOutputTypeDef
  2. See ResponseMetadataTypeDef

UpdateBackendAuthRequestRequestTypeDef#

# UpdateBackendAuthRequestRequestTypeDef definition

class UpdateBackendAuthRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: UpdateBackendAuthResourceConfigTypeDef,  # (1)
    ResourceName: str,
  1. See UpdateBackendAuthResourceConfigTypeDef

CreateBackendAuthResourceConfigTypeDef#

# CreateBackendAuthResourceConfigTypeDef definition

class CreateBackendAuthResourceConfigTypeDef(TypedDict):
    AuthResources: AuthResourcesType,  # (1)
    Service: ServiceType,  # (3)
    UserPoolConfigs: CreateBackendAuthUserPoolConfigUnionTypeDef,  # (4)
    IdentityPoolConfigs: NotRequired[CreateBackendAuthIdentityPoolConfigTypeDef],  # (2)
  1. See AuthResourcesType
  2. See CreateBackendAuthIdentityPoolConfigTypeDef
  3. See ServiceType
  4. See CreateBackendAuthUserPoolConfigTypeDef CreateBackendAuthUserPoolConfigOutputTypeDef

CreateBackendAuthRequestRequestTypeDef#

# CreateBackendAuthRequestRequestTypeDef definition

class CreateBackendAuthRequestRequestTypeDef(TypedDict):
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: CreateBackendAuthResourceConfigTypeDef,  # (1)
    ResourceName: str,
  1. See CreateBackendAuthResourceConfigTypeDef