AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AmplifyBackendPaginatorFactory

Paginators for the AmplifyBackend service

Class BackendAPIAppSyncAuthSettings

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

Class BackendAPIAuthType

Describes the auth types for your configured data models.

Class BackendAPIConflictResolution

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

Class BackendAPIResourceConfig

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

Class BackendAuthAppleProviderConfig

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

Class BackendAuthSocialProviderConfig

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

Class BackendJobRespObj

The response object for this operation.

Class BackendStoragePermissions

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

Class BadRequestException

An error returned if a request is not formed properly.

Class CloneBackendRequest

Container for the parameters to the CloneBackend operation. This operation clones an existing backend.

Class CloneBackendResponse

This is the response object from the CloneBackend operation.

Class CreateBackendAPIRequest

Container for the parameters to the CreateBackendAPI operation. Creates a new backend API resource.

Class CreateBackendAPIResponse

This is the response object from the CreateBackendAPI operation.

Class CreateBackendAuthForgotPasswordConfig

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

Class CreateBackendAuthIdentityPoolConfig

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

Class CreateBackendAuthMFAConfig

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

Class CreateBackendAuthOAuthConfig

Creates the OAuth configuration for your Amplify project.

Class CreateBackendAuthPasswordPolicyConfig

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

Class CreateBackendAuthRequest

Container for the parameters to the CreateBackendAuth operation. Creates a new backend authentication resource.

Class CreateBackendAuthResourceConfig

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

Class CreateBackendAuthResponse

This is the response object from the CreateBackendAuth operation.

Class CreateBackendAuthUserPoolConfig

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

Class CreateBackendAuthVerificationMessageConfig

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

Class CreateBackendConfigRequest

Container for the parameters to the CreateBackendConfig operation. Creates a config object for a backend.

Class CreateBackendConfigResponse

This is the response object from the CreateBackendConfig operation.

Class CreateBackendRequest

Container for the parameters to the CreateBackend operation. This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

Class CreateBackendResponse

This is the response object from the CreateBackend operation.

Class CreateBackendStorageRequest

Container for the parameters to the CreateBackendStorage operation. Creates a backend storage resource.

Class CreateBackendStorageResourceConfig

The resource configuration for creating backend storage.

Class CreateBackendStorageResponse

This is the response object from the CreateBackendStorage operation.

Class CreateTokenRequest

Container for the parameters to the CreateToken operation. Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

Class CreateTokenResponse

This is the response object from the CreateToken operation.

Class DeleteBackendAPIRequest

Container for the parameters to the DeleteBackendAPI operation. Deletes an existing backend API resource.

Class DeleteBackendAPIResponse

This is the response object from the DeleteBackendAPI operation.

Class DeleteBackendAuthRequest

Container for the parameters to the DeleteBackendAuth operation. Deletes an existing backend authentication resource.

Class DeleteBackendAuthResponse

This is the response object from the DeleteBackendAuth operation.

Class DeleteBackendRequest

Container for the parameters to the DeleteBackend operation. Removes an existing environment from your Amplify project.

Class DeleteBackendResponse

This is the response object from the DeleteBackend operation.

Class DeleteBackendStorageRequest

Container for the parameters to the DeleteBackendStorage operation. Removes the specified backend storage resource.

Class DeleteBackendStorageResponse

This is the response object from the DeleteBackendStorage operation.

Class DeleteTokenRequest

Container for the parameters to the DeleteToken operation. Deletes the challenge token based on the given appId and sessionId.

Class DeleteTokenResponse

This is the response object from the DeleteToken operation.

Class EmailSettings

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

Class GatewayTimeoutException

An error returned if there's a temporary issue with the service.

Class GenerateBackendAPIModelsRequest

Container for the parameters to the GenerateBackendAPIModels operation. Generates a model schema for an existing backend API resource.

Class GenerateBackendAPIModelsResponse

This is the response object from the GenerateBackendAPIModels operation.

Class GetBackendAPIModelsRequest

Container for the parameters to the GetBackendAPIModels operation. Gets a model introspection schema for an existing backend API resource.

Class GetBackendAPIModelsResponse

This is the response object from the GetBackendAPIModels operation.

Class GetBackendAPIRequest

Container for the parameters to the GetBackendAPI operation. Gets the details for a backend API.

Class GetBackendAPIResponse

This is the response object from the GetBackendAPI operation.

Class GetBackendAuthRequest

Container for the parameters to the GetBackendAuth operation. Gets a backend auth details.

Class GetBackendAuthResponse

This is the response object from the GetBackendAuth operation.

Class GetBackendJobRequest

Container for the parameters to the GetBackendJob operation. Returns information about a specific job.

Class GetBackendJobResponse

This is the response object from the GetBackendJob operation.

Class GetBackendRequest

Container for the parameters to the GetBackend operation. Provides project-level details for your Amplify UI project.

Class GetBackendResponse

This is the response object from the GetBackend operation.

Class GetBackendStorageRequest

Container for the parameters to the GetBackendStorage operation. Gets details for a backend storage resource.

Class GetBackendStorageResourceConfig

The details for a backend storage resource.

Class GetBackendStorageResponse

This is the response object from the GetBackendStorage operation.

Class GetTokenRequest

Container for the parameters to the GetToken operation. Gets the challenge token based on the given appId and sessionId.

Class GetTokenResponse

This is the response object from the GetToken operation.

Class ImportBackendAuthRequest

Container for the parameters to the ImportBackendAuth operation. Imports an existing backend authentication resource.

Class ImportBackendAuthResponse

This is the response object from the ImportBackendAuth operation.

Class ImportBackendStorageRequest

Container for the parameters to the ImportBackendStorage operation. Imports an existing backend storage resource.

Class ImportBackendStorageResponse

This is the response object from the ImportBackendStorage operation.

Class ListBackendJobsRequest

Container for the parameters to the ListBackendJobs operation. Lists the jobs for the backend of an Amplify app.

Class ListBackendJobsResponse

This is the response object from the ListBackendJobs operation.

Class ListS3BucketsRequest

Container for the parameters to the ListS3Buckets operation. The list of S3 buckets in your account.

Class ListS3BucketsResponse

This is the response object from the ListS3Buckets operation.

Class LoginAuthConfigReqObj

The request object for this operation.

Class NotFoundException

An error returned when a specific resource type is not found.

Class RemoveAllBackendsRequest

Container for the parameters to the RemoveAllBackends operation. Removes all backend environments from your Amplify project.

Class RemoveAllBackendsResponse

This is the response object from the RemoveAllBackends operation.

Class RemoveBackendConfigRequest

Container for the parameters to the RemoveBackendConfig operation. Removes the AWS resources required to access the Amplify Admin UI.

Class RemoveBackendConfigResponse

This is the response object from the RemoveBackendConfig operation.

Class ResourceConfig

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

Class S3BucketInfo

Describes the metadata of the S3 bucket.

Class Settings

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

Class SmsSettings

SMS settings for authentication.

Class SocialProviderSettings

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

Class TooManyRequestsException

An error that is returned when a limit of a specific type has been exceeded.

Class UpdateBackendAPIRequest

Container for the parameters to the UpdateBackendAPI operation. Updates an existing backend API resource.

Class UpdateBackendAPIResponse

This is the response object from the UpdateBackendAPI operation.

Class UpdateBackendAuthForgotPasswordConfig

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

Class UpdateBackendAuthIdentityPoolConfig

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

Class UpdateBackendAuthMFAConfig

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

Class UpdateBackendAuthOAuthConfig

The OAuth configurations for authenticating users into your Amplify app.

Class UpdateBackendAuthPasswordPolicyConfig

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

Class UpdateBackendAuthRequest

Container for the parameters to the UpdateBackendAuth operation. Updates an existing backend authentication resource.

Class UpdateBackendAuthResourceConfig

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

Class UpdateBackendAuthResponse

This is the response object from the UpdateBackendAuth operation.

Class UpdateBackendAuthUserPoolConfig

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

Class UpdateBackendAuthVerificationMessageConfig

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

Class UpdateBackendConfigRequest

Container for the parameters to the UpdateBackendConfig operation. Updates the AWS resources required to access the Amplify Admin UI.

Class UpdateBackendConfigResponse

This is the response object from the UpdateBackendConfig operation.

Class UpdateBackendJobRequest

Container for the parameters to the UpdateBackendJob operation. Updates a specific job.

Class UpdateBackendJobResponse

This is the response object from the UpdateBackendJob operation.

Class UpdateBackendStorageRequest

Container for the parameters to the UpdateBackendStorage operation. Updates an existing backend storage resource.

Class UpdateBackendStorageResourceConfig

The resource configuration for updating backend storage.

Class UpdateBackendStorageResponse

This is the response object from the UpdateBackendStorage operation.

Interfaces

NameDescription
Interface IAmplifyBackendPaginatorFactory

Paginators for the AmplifyBackend service

Interface IListBackendJobsPaginator

Paginator for the ListBackendJobs operation