AmplifyBackend class

AWS Amplify Admin API

Constructors

AmplifyBackend({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

cloneBackend({required String appId, required String backendEnvironmentName, required String targetEnvironmentName}) → Future<CloneBackendResponse>

This operation clones an existing backend.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createBackend({required String appId, required String appName, required String backendEnvironmentName, ResourceConfig? resourceConfig, String? resourceName}) → Future<CreateBackendResponse>

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

createBackendAPI({required String appId, required String backendEnvironmentName, required BackendAPIResourceConfig resourceConfig, required String resourceName}) → Future<CreateBackendAPIResponse>

Creates a new backend API resource.

createBackendAuth({required String appId, required String backendEnvironmentName, required CreateBackendAuthResourceConfig resourceConfig, required String resourceName}) → Future<CreateBackendAuthResponse>

Creates a new backend authentication resource.

createBackendConfig({required String appId, String? backendManagerAppId}) → Future<CreateBackendConfigResponse>

Creates a config object for a backend.

createBackendStorage({required String appId, required String backendEnvironmentName, required CreateBackendStorageResourceConfig resourceConfig, required String resourceName}) → Future<CreateBackendStorageResponse>

Creates a backend storage resource.

createToken({required String appId}) → Future<CreateTokenResponse>

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

deleteBackend({required String appId, required String backendEnvironmentName}) → Future<DeleteBackendResponse>

Removes an existing environment from your Amplify project.

deleteBackendAPI({required String appId, required String backendEnvironmentName, required String resourceName, BackendAPIResourceConfig? resourceConfig}) → Future<DeleteBackendAPIResponse>

Deletes an existing backend API resource.

deleteBackendAuth({required String appId, required String backendEnvironmentName, required String resourceName}) → Future<DeleteBackendAuthResponse>

Deletes an existing backend authentication resource.

deleteBackendStorage({required String appId, required String backendEnvironmentName, required String resourceName, required ServiceName serviceName}) → Future<DeleteBackendStorageResponse>

Removes the specified backend storage resource.

deleteToken({required String appId, required String sessionId}) → Future<DeleteTokenResponse>

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

generateBackendAPIModels({required String appId, required String backendEnvironmentName, required String resourceName}) → Future<GenerateBackendAPIModelsResponse>

Generates a model schema for an existing backend API resource.

getBackend({required String appId, String? backendEnvironmentName}) → Future<GetBackendResponse>

Provides project-level details for your Amplify UI project.

getBackendAPI({required String appId, required String backendEnvironmentName, required String resourceName, BackendAPIResourceConfig? resourceConfig}) → Future<GetBackendAPIResponse>

Gets the details for a backend API.

getBackendAPIModels({required String appId, required String backendEnvironmentName, required String resourceName}) → Future<GetBackendAPIModelsResponse>

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

getBackendAuth({required String appId, required String backendEnvironmentName, required String resourceName}) → Future<GetBackendAuthResponse>

Gets a backend auth details.

getBackendJob({required String appId, required String backendEnvironmentName, required String jobId}) → Future<GetBackendJobResponse>

Returns information about a specific job.

getBackendStorage({required String appId, required String backendEnvironmentName, required String resourceName}) → Future<GetBackendStorageResponse>

Gets details for a backend storage resource.

getToken({required String appId, required String sessionId}) → Future<GetTokenResponse>

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

importBackendAuth({required String appId, required String backendEnvironmentName, required String nativeClientId, required String userPoolId, required String webClientId, String? identityPoolId}) → Future<ImportBackendAuthResponse>

Imports an existing backend authentication resource.

importBackendStorage({required String appId, required String backendEnvironmentName, required ServiceName serviceName, String? bucketName}) → Future<ImportBackendStorageResponse>

Imports an existing backend storage resource.

listBackendJobs({required String appId, required String backendEnvironmentName, String? jobId, int? maxResults, String? nextToken, String? operation, String? status}) → Future<ListBackendJobsResponse>

Lists the jobs for the backend of an Amplify app.

listS3Buckets({String? nextToken}) → Future<ListS3BucketsResponse>

The list of S3 buckets in your account.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeAllBackends({required String appId, bool? cleanAmplifyApp}) → Future<RemoveAllBackendsResponse>

Removes all backend environments from your Amplify project.

removeBackendConfig({required String appId}) → Future<RemoveBackendConfigResponse>

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

toString() → String

A string representation of this object.

inherited

updateBackendAPI({required String appId, required String backendEnvironmentName, required String resourceName, BackendAPIResourceConfig? resourceConfig}) → Future<UpdateBackendAPIResponse>

Updates an existing backend API resource.

updateBackendAuth({required String appId, required String backendEnvironmentName, required UpdateBackendAuthResourceConfig resourceConfig, required String resourceName}) → Future<UpdateBackendAuthResponse>

Updates an existing backend authentication resource.

updateBackendConfig({required String appId, LoginAuthConfigReqObj? loginAuthConfig}) → Future<UpdateBackendConfigResponse>

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

updateBackendJob({required String appId, required String backendEnvironmentName, required String jobId, String? operation, String? status}) → Future<UpdateBackendJobResponse>

Updates a specific job.

updateBackendStorage({required String appId, required String backendEnvironmentName, required UpdateBackendStorageResourceConfig resourceConfig, required String resourceName}) → Future<UpdateBackendStorageResponse>

Updates an existing backend storage resource.

Operators

operator ==(Object other) → bool

The equality operator.

inherited