Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that AmplifyBackend can respond with.

Structs

BackendApiAppSyncAuthSettings

The authentication settings for accessing provisioned data models in your Amplify project.

BackendApiAuthType

Describes the auth types for your configured data models.

BackendApiConflictResolution

Describes the conflict resolution configuration for your data model configured in your Amplify project.

BackendApiResourceConfig

The resource config for the data model, configured as a part of the Amplify project.

BackendAuthAppleProviderConfig

Describes Apple social federation configurations for allowing your app users to sign in using OAuth.

BackendAuthSocialProviderConfig

Describes third-party social federation configurations for allowing your app users to sign in using OAuth.

BackendJobRespObj

The response object for this operation.

BackendStoragePermissions

Describes the read, write, and delete permissions users have against your storage S3 bucket.

CreateBackendAuthForgotPasswordConfig

(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.

CreateBackendAuthIdentityPoolConfig

Describes authorization configurations for the auth resources, configured as a part of your Amplify project.

CreateBackendAuthMfaConfig

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

CreateBackendAuthOAuthConfig

Creates the OAuth configuration for your Amplify project.

CreateBackendAuthPasswordPolicyConfig

The password policy configuration for the backend to your Amplify project.

CreateBackendAuthResourceConfig

Defines the resource configuration when creating an auth resource in your Amplify project.

CreateBackendAuthUserPoolConfig

Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.

CreateBackendAuthVerificationMessageConfig

Creates an email or SMS verification message for the auth resource configured for your Amplify project.

CreateBackendStorageResourceConfig

The resource configuration for creating backend storage.

EmailSettings

The configuration for the email sent when an app user forgets their password.

GetBackendStorageResourceConfig

The details for a backend storage resource.

LoginAuthConfigReqObj

The request object for this operation.

ResourceConfig

Defines the resource configuration for the data model in your Amplify project.

S3BucketInfo

Describes the metadata of the S3 bucket.

Settings

The settings of your MFA configuration for the backend of your Amplify project.

SmsSettings

SMS settings for authentication.

SocialProviderSettings

The settings for using the social identity providers for access to your Amplify app.

UpdateBackendAuthForgotPasswordConfig

(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.

UpdateBackendAuthIdentityPoolConfig

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

UpdateBackendAuthMfaConfig

Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.

UpdateBackendAuthOAuthConfig

The OAuth configurations for authenticating users into your Amplify app.

UpdateBackendAuthPasswordPolicyConfig

Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.

UpdateBackendAuthResourceConfig

Defines the resource configuration when updating an authentication resource in your Amplify project.

UpdateBackendAuthUserPoolConfig

Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.

UpdateBackendAuthVerificationMessageConfig

Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.

UpdateBackendStorageResourceConfig

The resource configuration for updating backend storage.

Enums

AdditionalConstraintsElement

When writing a match expression against AdditionalConstraintsElement, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AuthResources

When writing a match expression against AuthResources, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AuthenticatedElement

When writing a match expression against AuthenticatedElement, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DeliveryMethod

When writing a match expression against DeliveryMethod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MfaMode

When writing a match expression against MfaMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MfaTypesElement

When writing a match expression against MfaTypesElement, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Mode

When writing a match expression against Mode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OAuthGrantType

When writing a match expression against OAuthGrantType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OAuthScopesElement

When writing a match expression against OAuthScopesElement, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RequiredSignUpAttributesElement

When writing a match expression against RequiredSignUpAttributesElement, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ResolutionStrategy

When writing a match expression against ResolutionStrategy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Service

When writing a match expression against Service, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ServiceName

When writing a match expression against ServiceName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SignInMethod

When writing a match expression against SignInMethod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Status

When writing a match expression against Status, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

UnAuthenticatedElement

When writing a match expression against UnAuthenticatedElement, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.