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.

Interface for accessing AmplifyBackend

AWS Amplify Admin API

Inheritance Hierarchy

Amazon.AmplifyBackend.IAmazonAmplifyBackend

Namespace: Amazon.AmplifyBackend
Assembly: AWSSDK.AmplifyBackend.dll
Version: 3.x.y.z

Syntax

C# 
public interface IAmazonAmplifyBackend
         IAmazonService, IDisposable

The IAmazonAmplifyBackend type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.AmplifyBackend.Model.IAmplifyBackendPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CloneBackend(CloneBackendRequest)

This operation clones an existing backend.

Public Method CloneBackendAsync(CloneBackendRequest, CancellationToken)

This operation clones an existing backend.

Public Method CreateBackend(CreateBackendRequest)

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

Public Method CreateBackendAPI(CreateBackendAPIRequest)

Creates a new backend API resource.

Public Method CreateBackendAPIAsync(CreateBackendAPIRequest, CancellationToken)

Creates a new backend API resource.

Public Method CreateBackendAsync(CreateBackendRequest, CancellationToken)

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

Public Method CreateBackendAuth(CreateBackendAuthRequest)

Creates a new backend authentication resource.

Public Method CreateBackendAuthAsync(CreateBackendAuthRequest, CancellationToken)

Creates a new backend authentication resource.

Public Method CreateBackendConfig(CreateBackendConfigRequest)

Creates a config object for a backend.

Public Method CreateBackendConfigAsync(CreateBackendConfigRequest, CancellationToken)

Creates a config object for a backend.

Public Method CreateBackendStorage(CreateBackendStorageRequest)

Creates a backend storage resource.

Public Method CreateBackendStorageAsync(CreateBackendStorageRequest, CancellationToken)

Creates a backend storage resource.

Public Method CreateToken(CreateTokenRequest)

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

Public Method CreateTokenAsync(CreateTokenRequest, CancellationToken)

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

Public Method DeleteBackend(DeleteBackendRequest)

Removes an existing environment from your Amplify project.

Public Method DeleteBackendAPI(DeleteBackendAPIRequest)

Deletes an existing backend API resource.

Public Method DeleteBackendAPIAsync(DeleteBackendAPIRequest, CancellationToken)

Deletes an existing backend API resource.

Public Method DeleteBackendAsync(DeleteBackendRequest, CancellationToken)

Removes an existing environment from your Amplify project.

Public Method DeleteBackendAuth(DeleteBackendAuthRequest)

Deletes an existing backend authentication resource.

Public Method DeleteBackendAuthAsync(DeleteBackendAuthRequest, CancellationToken)

Deletes an existing backend authentication resource.

Public Method DeleteBackendStorage(DeleteBackendStorageRequest)

Removes the specified backend storage resource.

Public Method DeleteBackendStorageAsync(DeleteBackendStorageRequest, CancellationToken)

Removes the specified backend storage resource.

Public Method DeleteToken(DeleteTokenRequest)

Deletes the challenge token based on the given appId and sessionId.

Public Method DeleteTokenAsync(DeleteTokenRequest, CancellationToken)

Deletes the challenge token based on the given appId and sessionId.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method GenerateBackendAPIModels(GenerateBackendAPIModelsRequest)

Generates a model schema for an existing backend API resource.

Public Method GenerateBackendAPIModelsAsync(GenerateBackendAPIModelsRequest, CancellationToken)

Generates a model schema for an existing backend API resource.

Public Method GetBackend(GetBackendRequest)

Provides project-level details for your Amplify UI project.

Public Method GetBackendAPI(GetBackendAPIRequest)

Gets the details for a backend API.

Public Method GetBackendAPIAsync(GetBackendAPIRequest, CancellationToken)

Gets the details for a backend API.

Public Method GetBackendAPIModels(GetBackendAPIModelsRequest)

Gets a model introspection schema for an existing backend API resource.

Public Method GetBackendAPIModelsAsync(GetBackendAPIModelsRequest, CancellationToken)

Gets a model introspection schema for an existing backend API resource.

Public Method GetBackendAsync(GetBackendRequest, CancellationToken)

Provides project-level details for your Amplify UI project.

Public Method GetBackendAuth(GetBackendAuthRequest)

Gets a backend auth details.

Public Method GetBackendAuthAsync(GetBackendAuthRequest, CancellationToken)

Gets a backend auth details.

Public Method GetBackendJob(GetBackendJobRequest)

Returns information about a specific job.

Public Method GetBackendJobAsync(GetBackendJobRequest, CancellationToken)

Returns information about a specific job.

Public Method GetBackendStorage(GetBackendStorageRequest)

Gets details for a backend storage resource.

Public Method GetBackendStorageAsync(GetBackendStorageRequest, CancellationToken)

Gets details for a backend storage resource.

Public Method GetToken(GetTokenRequest)

Gets the challenge token based on the given appId and sessionId.

Public Method GetTokenAsync(GetTokenRequest, CancellationToken)

Gets the challenge token based on the given appId and sessionId.

Public Method ImportBackendAuth(ImportBackendAuthRequest)

Imports an existing backend authentication resource.

Public Method ImportBackendAuthAsync(ImportBackendAuthRequest, CancellationToken)

Imports an existing backend authentication resource.

Public Method ImportBackendStorage(ImportBackendStorageRequest)

Imports an existing backend storage resource.

Public Method ImportBackendStorageAsync(ImportBackendStorageRequest, CancellationToken)

Imports an existing backend storage resource.

Public Method ListBackendJobs(ListBackendJobsRequest)

Lists the jobs for the backend of an Amplify app.

Public Method ListBackendJobsAsync(ListBackendJobsRequest, CancellationToken)

Lists the jobs for the backend of an Amplify app.

Public Method ListS3Buckets(ListS3BucketsRequest)

The list of S3 buckets in your account.

Public Method ListS3BucketsAsync(ListS3BucketsRequest, CancellationToken)

The list of S3 buckets in your account.

Public Method RemoveAllBackends(RemoveAllBackendsRequest)

Removes all backend environments from your Amplify project.

Public Method RemoveAllBackendsAsync(RemoveAllBackendsRequest, CancellationToken)

Removes all backend environments from your Amplify project.

Public Method RemoveBackendConfig(RemoveBackendConfigRequest)

Removes the AWS resources required to access the Amplify Admin UI.

Public Method RemoveBackendConfigAsync(RemoveBackendConfigRequest, CancellationToken)

Removes the AWS resources required to access the Amplify Admin UI.

Public Method UpdateBackendAPI(UpdateBackendAPIRequest)

Updates an existing backend API resource.

Public Method UpdateBackendAPIAsync(UpdateBackendAPIRequest, CancellationToken)

Updates an existing backend API resource.

Public Method UpdateBackendAuth(UpdateBackendAuthRequest)

Updates an existing backend authentication resource.

Public Method UpdateBackendAuthAsync(UpdateBackendAuthRequest, CancellationToken)

Updates an existing backend authentication resource.

Public Method UpdateBackendConfig(UpdateBackendConfigRequest)

Updates the AWS resources required to access the Amplify Admin UI.

Public Method UpdateBackendConfigAsync(UpdateBackendConfigRequest, CancellationToken)

Updates the AWS resources required to access the Amplify Admin UI.

Public Method UpdateBackendJob(UpdateBackendJobRequest)

Updates a specific job.

Public Method UpdateBackendJobAsync(UpdateBackendJobRequest, CancellationToken)

Updates a specific job.

Public Method UpdateBackendStorage(UpdateBackendStorageRequest)

Updates an existing backend storage resource.

Public Method UpdateBackendStorageAsync(UpdateBackendStorageRequest, CancellationToken)

Updates an existing backend storage resource.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5