Skip to content

Amplifybackend Classes

BackendAPIAppSyncAuthSettings

CognitoUserPoolId

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

ExpirationTime

  • Type: typing.Optional[float]

OpenIDAuthTTL

  • Type: typing.Optional[str]

OpenIDClientId

  • Type: typing.Optional[str]

OpenIDIatTTL

  • Type: typing.Optional[str]

OpenIDIssueURL

  • Type: typing.Optional[str]

OpenIDProviderName

  • Type: typing.Optional[str]

BackendAPIAuthType

Mode

  • Type: typing.Optional[typing.Literal['AMAZON_COGNITO_USER_POOLS', 'API_KEY', 'AWS_IAM', 'OPENID_CONNECT']]

Settings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIAppSyncAuthSettings]

BackendAPIConflictResolution

ResolutionStrategy

  • Type: typing.Optional[typing.Literal['AUTOMERGE', 'LAMBDA', 'NONE', 'OPTIMISTIC_CONCURRENCY']]

BackendAPIResourceConfig

AdditionalAuthTypes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIAuthType]]

ApiName

  • Type: typing.Optional[str]

ConflictResolution

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIConflictResolution]

DefaultAuthType

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIAuthType]

Service

  • Type: typing.Optional[str]

TransformSchema

  • Type: typing.Optional[str]

BackendAPIResourceConfigOutput

AdditionalAuthTypes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIAuthType]]

ApiName

  • Type: typing.Optional[str]

ConflictResolution

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIConflictResolution]

DefaultAuthType

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIAuthType]

Service

  • Type: typing.Optional[str]

TransformSchema

  • Type: typing.Optional[str]

BackendAuthAppleProviderConfig

ClientId

  • Type: typing.Optional[str]

KeyId

  • Type: typing.Optional[str]

PrivateKey

  • Type: typing.Optional[str]

TeamId

  • Type: typing.Optional[str]

BackendAuthSocialProviderConfig

ClientId

  • Type: typing.Optional[str]

ClientSecret

  • Type: typing.Optional[str]

BackendJobRespObj

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

CreateTime

  • Type: typing.Optional[str]

Error

  • Type: typing.Optional[str]

JobId

  • Type: typing.Optional[str]

Operation

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[str]

UpdateTime

  • Type: typing.Optional[str]

BackendStoragePermissions

Authenticated

  • Type: typing.List[typing.Literal['CREATE_AND_UPDATE', 'DELETE', 'READ']]
  • Required: Yes

UnAuthenticated

  • Type: typing.Optional[typing.List[typing.Literal['CREATE_AND_UPDATE', 'DELETE', 'READ']]]

BackendStoragePermissionsOutput

Authenticated

  • Type: typing.List[typing.Literal['CREATE_AND_UPDATE', 'DELETE', 'READ']]
  • Required: Yes

UnAuthenticated

  • Type: typing.Optional[typing.List[typing.Literal['CREATE_AND_UPDATE', 'DELETE', 'READ']]]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CloneBackendRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

TargetEnvironmentName

  • Type:
  • Required: Yes

CloneBackendResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateBackendAPIRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceConfig

  • Type: typing.Union[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIResourceConfig, aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIResourceConfigOutput]
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

CreateBackendAPIResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateBackendAuthForgotPasswordConfig

DeliveryMethod

  • Type: typing.Literal['EMAIL', 'SMS']
  • Required: Yes

EmailSettings

  • Type:

SmsSettings

  • Type:

CreateBackendAuthIdentityPoolConfig

IdentityPoolName

  • Type:
  • Required: Yes

UnauthenticatedLogin

  • Type:
  • Required: Yes

CreateBackendAuthMFAConfig

MFAMode

  • Type: typing.Literal['OFF', 'ON', 'OPTIONAL']
  • Required: Yes

Settings

  • Type:

CreateBackendAuthMFAConfigOutput

MFAMode

  • Type: typing.Literal['OFF', 'ON', 'OPTIONAL']
  • Required: Yes

Settings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.SettingsOutput]

CreateBackendAuthOAuthConfig

OAuthGrantType

  • Type: typing.Literal['CODE', 'IMPLICIT']
  • Required: Yes

OAuthScopes

  • Type: typing.List[typing.Literal['AWS_COGNITO_SIGNIN_USER_ADMIN', 'EMAIL', 'OPENID', 'PHONE', 'PROFILE']]
  • Required: Yes

RedirectSignInURIs

  • Type: typing.List[str]
  • Required: Yes

RedirectSignOutURIs

  • Type: typing.List[str]
  • Required: Yes

DomainPrefix

  • Type: typing.Optional[str]

SocialProviderSettings

  • Type:

CreateBackendAuthOAuthConfigOutput

OAuthGrantType

  • Type: typing.Literal['CODE', 'IMPLICIT']
  • Required: Yes

OAuthScopes

  • Type: typing.List[typing.Literal['AWS_COGNITO_SIGNIN_USER_ADMIN', 'EMAIL', 'OPENID', 'PHONE', 'PROFILE']]
  • Required: Yes

RedirectSignInURIs

  • Type: typing.List[str]
  • Required: Yes

RedirectSignOutURIs

  • Type: typing.List[str]
  • Required: Yes

DomainPrefix

  • Type: typing.Optional[str]

SocialProviderSettings

  • Type:

CreateBackendAuthPasswordPolicyConfig

MinimumLength

  • Type:
  • Required: Yes

AdditionalConstraints

  • Type: typing.Optional[typing.List[typing.Literal['REQUIRE_DIGIT', 'REQUIRE_LOWERCASE', 'REQUIRE_SYMBOL', 'REQUIRE_UPPERCASE']]]

CreateBackendAuthPasswordPolicyConfigOutput

MinimumLength

  • Type:
  • Required: Yes

AdditionalConstraints

  • Type: typing.Optional[typing.List[typing.Literal['REQUIRE_DIGIT', 'REQUIRE_LOWERCASE', 'REQUIRE_SYMBOL', 'REQUIRE_UPPERCASE']]]

CreateBackendAuthRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceConfig

  • Type: typing.Union[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.CreateBackendAuthResourceConfig, aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.CreateBackendAuthResourceConfigOutput]
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

CreateBackendAuthResourceConfig

AuthResources

  • Type: typing.Literal['IDENTITY_POOL_AND_USER_POOL', 'USER_POOL_ONLY']
  • Required: Yes

Service

  • Type: typing.Literal['COGNITO']
  • Required: Yes

UserPoolConfigs

  • Type:
  • Required: Yes

IdentityPoolConfigs

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.CreateBackendAuthIdentityPoolConfig]

CreateBackendAuthResourceConfigOutput

AuthResources

  • Type: typing.Literal['IDENTITY_POOL_AND_USER_POOL', 'USER_POOL_ONLY']
  • Required: Yes

Service

  • Type: typing.Literal['COGNITO']
  • Required: Yes

UserPoolConfigs

  • Type:
  • Required: Yes

IdentityPoolConfigs

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.CreateBackendAuthIdentityPoolConfig]

CreateBackendAuthResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateBackendAuthUserPoolConfig

RequiredSignUpAttributes

  • Type: typing.List[typing.Literal['ADDRESS', 'BIRTHDATE', 'EMAIL', 'FAMILY_NAME', 'GENDER', 'GIVEN_NAME', 'LOCALE', 'MIDDLE_NAME', 'NAME', 'NICKNAME', 'PHONE_NUMBER', 'PICTURE', 'PREFERRED_USERNAME', 'PROFILE', 'UPDATED_AT', 'WEBSITE', 'ZONE_INFO']]
  • Required: Yes

SignInMethod

  • Type: typing.Literal['EMAIL', 'EMAIL_AND_PHONE_NUMBER', 'PHONE_NUMBER', 'USERNAME']
  • Required: Yes

UserPoolName

  • Type:
  • Required: Yes

ForgotPassword

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.CreateBackendAuthForgotPasswordConfig]

Mfa

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.CreateBackendAuthMFAConfig]

OAuth

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.CreateBackendAuthOAuthConfig]

PasswordPolicy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.CreateBackendAuthPasswordPolicyConfig]

VerificationMessage

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.CreateBackendAuthVerificationMessageConfig]

CreateBackendAuthUserPoolConfigOutput

RequiredSignUpAttributes

  • Type: typing.List[typing.Literal['ADDRESS', 'BIRTHDATE', 'EMAIL', 'FAMILY_NAME', 'GENDER', 'GIVEN_NAME', 'LOCALE', 'MIDDLE_NAME', 'NAME', 'NICKNAME', 'PHONE_NUMBER', 'PICTURE', 'PREFERRED_USERNAME', 'PROFILE', 'UPDATED_AT', 'WEBSITE', 'ZONE_INFO']]
  • Required: Yes

SignInMethod

  • Type: typing.Literal['EMAIL', 'EMAIL_AND_PHONE_NUMBER', 'PHONE_NUMBER', 'USERNAME']
  • Required: Yes

UserPoolName

  • Type:
  • Required: Yes

ForgotPassword

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.CreateBackendAuthForgotPasswordConfig]

Mfa

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.CreateBackendAuthMFAConfigOutput]

OAuth

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.CreateBackendAuthOAuthConfigOutput]

PasswordPolicy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.CreateBackendAuthPasswordPolicyConfigOutput]

VerificationMessage

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.CreateBackendAuthVerificationMessageConfig]

CreateBackendAuthVerificationMessageConfig

DeliveryMethod

  • Type: typing.Literal['EMAIL', 'SMS']
  • Required: Yes

EmailSettings

  • Type:

SmsSettings

  • Type:

CreateBackendConfigRequest

AppId

  • Type:
  • Required: Yes

BackendManagerAppId

  • Type: typing.Optional[str]

CreateBackendConfigResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateBackendRequest

AppId

  • Type:
  • Required: Yes

AppName

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceConfig

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

ResourceName

  • Type: typing.Optional[str]

CreateBackendResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateBackendStorageRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceConfig

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

CreateBackendStorageResourceConfig

Permissions

  • Type: typing.Union[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendStoragePermissions, aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendStoragePermissionsOutput]
  • Required: Yes

ServiceName

  • Type: typing.Literal['S3']
  • Required: Yes

BucketName

  • Type: typing.Optional[str]

CreateBackendStorageResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateTokenRequest

AppId

  • Type:
  • Required: Yes

CreateTokenResponse

AppId

  • Type:
  • Required: Yes

ChallengeCode

  • Type:
  • Required: Yes

SessionId

  • Type:
  • Required: Yes

Ttl

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteBackendAPIRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

ResourceConfig

  • Type: typing.Union[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIResourceConfig, aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIResourceConfigOutput, NoneType]

DeleteBackendAPIResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteBackendAuthRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

DeleteBackendAuthResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteBackendRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

DeleteBackendResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteBackendStorageRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

ServiceName

  • Type: typing.Literal['S3']
  • Required: Yes

DeleteBackendStorageResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteTokenRequest

AppId

  • Type:
  • Required: Yes

SessionId

  • Type:
  • Required: Yes

DeleteTokenResponse

IsSuccess

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

EmailSettings

EmailMessage

  • Type: typing.Optional[str]

EmailSubject

  • Type: typing.Optional[str]

GenerateBackendAPIModelsRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

GenerateBackendAPIModelsResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetBackendAPIModelsRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

GetBackendAPIModelsResponse

Models

  • Type:
  • Required: Yes

Status

  • Type: typing.Literal['LATEST', 'STALE']
  • Required: Yes

ModelIntrospectionSchema

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetBackendAPIRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

ResourceConfig

  • Type: typing.Union[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIResourceConfig, aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIResourceConfigOutput, NoneType]

GetBackendAPIResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

ResourceConfig

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetBackendAuthRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

GetBackendAuthResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

ResourceConfig

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetBackendJobRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

GetBackendJobResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

CreateTime

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

UpdateTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetBackendRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type: typing.Optional[str]

GetBackendResponse

AmplifyFeatureFlags

  • Type:
  • Required: Yes

AmplifyMetaConfig

  • Type:
  • Required: Yes

AppId

  • Type:
  • Required: Yes

AppName

  • Type:
  • Required: Yes

BackendEnvironmentList

  • Type: typing.List[str]
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetBackendStorageRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

GetBackendStorageResourceConfig

Imported

  • Type:
  • Required: Yes

ServiceName

  • Type: typing.Literal['S3']
  • Required: Yes

BucketName

  • Type: typing.Optional[str]

Permissions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendStoragePermissionsOutput]

GetBackendStorageResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceConfig

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetTokenRequest

AppId

  • Type:
  • Required: Yes

SessionId

  • Type:
  • Required: Yes

GetTokenResponse

AppId

  • Type:
  • Required: Yes

ChallengeCode

  • Type:
  • Required: Yes

SessionId

  • Type:
  • Required: Yes

Ttl

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ImportBackendAuthRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

NativeClientId

  • Type:
  • Required: Yes

UserPoolId

  • Type:
  • Required: Yes

WebClientId

  • Type:
  • Required: Yes

IdentityPoolId

  • Type: typing.Optional[str]

ImportBackendAuthResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ImportBackendStorageRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ServiceName

  • Type: typing.Literal['S3']
  • Required: Yes

BucketName

  • Type: typing.Optional[str]

ImportBackendStorageResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListBackendJobsRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

JobId

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

Operation

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[str]

ListBackendJobsRequestPaginate

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

JobId

  • Type: typing.Optional[str]

Operation

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.PaginatorConfig]

ListBackendJobsResponse

Jobs

  • Type: typing.List[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendJobRespObj]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListS3BucketsRequest

NextToken

  • Type: typing.Optional[str]

ListS3BucketsResponse

Buckets

  • Type: typing.List[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.S3BucketInfo]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

LoginAuthConfigReqObj

AwsCognitoIdentityPoolId

  • Type: typing.Optional[str]

AwsCognitoRegion

  • Type: typing.Optional[str]

AwsUserPoolsId

  • Type: typing.Optional[str]

AwsUserPoolsWebClientId

  • Type: typing.Optional[str]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

RemoveAllBackendsRequest

AppId

  • Type:
  • Required: Yes

CleanAmplifyApp

  • Type: typing.Optional[bool]

RemoveAllBackendsResponse

AppId

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RemoveBackendConfigRequest

AppId

  • Type:
  • Required: Yes

RemoveBackendConfigResponse

Error

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

S3BucketInfo

CreationDate

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

Settings

MfaTypes

  • Type: typing.Optional[typing.List[typing.Literal['SMS', 'TOTP']]]

SmsMessage

  • Type: typing.Optional[str]

SettingsOutput

MfaTypes

  • Type: typing.Optional[typing.List[typing.Literal['SMS', 'TOTP']]]

SmsMessage

  • Type: typing.Optional[str]

SmsSettings

SmsMessage

  • Type: typing.Optional[str]

SocialProviderSettings

Facebook

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAuthSocialProviderConfig]

Google

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAuthSocialProviderConfig]

LoginWithAmazon

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAuthSocialProviderConfig]

SignInWithApple

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAuthAppleProviderConfig]

UpdateBackendAPIRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

ResourceConfig

  • Type: typing.Union[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIResourceConfig, aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendAPIResourceConfigOutput, NoneType]

UpdateBackendAPIResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateBackendAuthForgotPasswordConfig

DeliveryMethod

  • Type: typing.Optional[typing.Literal['EMAIL', 'SMS']]

EmailSettings

  • Type:

SmsSettings

  • Type:

UpdateBackendAuthIdentityPoolConfig

UnauthenticatedLogin

  • Type: typing.Optional[bool]

UpdateBackendAuthMFAConfig

MFAMode

  • Type: typing.Optional[typing.Literal['OFF', 'ON', 'OPTIONAL']]

Settings

  • Type: typing.Union[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.Settings, aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.SettingsOutput, NoneType]

UpdateBackendAuthOAuthConfig

DomainPrefix

  • Type: typing.Optional[str]

OAuthGrantType

  • Type: typing.Optional[typing.Literal['CODE', 'IMPLICIT']]

OAuthScopes

  • Type: typing.Optional[typing.List[typing.Literal['AWS_COGNITO_SIGNIN_USER_ADMIN', 'EMAIL', 'OPENID', 'PHONE', 'PROFILE']]]

RedirectSignInURIs

  • Type: typing.Optional[typing.List[str]]

RedirectSignOutURIs

  • Type: typing.Optional[typing.List[str]]

SocialProviderSettings

  • Type:

UpdateBackendAuthPasswordPolicyConfig

AdditionalConstraints

  • Type: typing.Optional[typing.List[typing.Literal['REQUIRE_DIGIT', 'REQUIRE_LOWERCASE', 'REQUIRE_SYMBOL', 'REQUIRE_UPPERCASE']]]

MinimumLength

  • Type: typing.Optional[float]

UpdateBackendAuthRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceConfig

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

UpdateBackendAuthResourceConfig

AuthResources

  • Type: typing.Literal['IDENTITY_POOL_AND_USER_POOL', 'USER_POOL_ONLY']
  • Required: Yes

Service

  • Type: typing.Literal['COGNITO']
  • Required: Yes

UserPoolConfigs

  • Type:
  • Required: Yes

IdentityPoolConfigs

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.UpdateBackendAuthIdentityPoolConfig]

UpdateBackendAuthResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateBackendAuthUserPoolConfig

ForgotPassword

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.UpdateBackendAuthForgotPasswordConfig]

Mfa

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.UpdateBackendAuthMFAConfig]

OAuth

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.UpdateBackendAuthOAuthConfig]

PasswordPolicy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.UpdateBackendAuthPasswordPolicyConfig]

VerificationMessage

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.UpdateBackendAuthVerificationMessageConfig]

UpdateBackendAuthVerificationMessageConfig

DeliveryMethod

  • Type: typing.Literal['EMAIL', 'SMS']
  • Required: Yes

EmailSettings

  • Type:

SmsSettings

  • Type:

UpdateBackendConfigRequest

AppId

  • Type:
  • Required: Yes

LoginAuthConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.LoginAuthConfigReqObj]

UpdateBackendConfigResponse

AppId

  • Type:
  • Required: Yes

BackendManagerAppId

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

LoginAuthConfig

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateBackendJobRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[str]

UpdateBackendJobResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

CreateTime

  • Type:
  • Required: Yes

Error

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Operation

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

UpdateTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateBackendStorageRequest

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

ResourceConfig

  • Type:
  • Required: Yes

ResourceName

  • Type:
  • Required: Yes

UpdateBackendStorageResourceConfig

Permissions

  • Type: typing.Union[aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendStoragePermissions, aws_resource_validator.pydantic_models.amplifybackend.amplifybackend_classes.BackendStoragePermissionsOutput]
  • Required: Yes

ServiceName

  • Type: typing.Literal['S3']
  • Required: Yes

UpdateBackendStorageResponse

AppId

  • Type:
  • Required: Yes

BackendEnvironmentName

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes