Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

AmplifyBackend

import { AmplifyBackend } from "https://aws-api.deno.dev/v0.2/services/amplifybackend.ts?docs=full";
class AmplifyBackend {
constructor(apiFactory: client.ApiFactory);
async cloneBackend(params: CloneBackendRequest, opts?: client.RequestOptions): Promise<CloneBackendResponse>;
async createBackend(params: CreateBackendRequest, opts?: client.RequestOptions): Promise<CreateBackendResponse>;
async createBackendAPI(params: CreateBackendAPIRequest, opts?: client.RequestOptions): Promise<CreateBackendAPIResponse>;
async createBackendAuth(params: CreateBackendAuthRequest, opts?: client.RequestOptions): Promise<CreateBackendAuthResponse>;
async createBackendConfig(params: CreateBackendConfigRequest, opts?: client.RequestOptions): Promise<CreateBackendConfigResponse>;
async createToken(params: CreateTokenRequest, opts?: client.RequestOptions): Promise<CreateTokenResponse>;
async deleteBackend(params: DeleteBackendRequest, opts?: client.RequestOptions): Promise<DeleteBackendResponse>;
async deleteBackendAPI(params: DeleteBackendAPIRequest, opts?: client.RequestOptions): Promise<DeleteBackendAPIResponse>;
async deleteBackendAuth(params: DeleteBackendAuthRequest, opts?: client.RequestOptions): Promise<DeleteBackendAuthResponse>;
async deleteToken(params: DeleteTokenRequest, opts?: client.RequestOptions): Promise<DeleteTokenResponse>;
async generateBackendAPIModels(params: GenerateBackendAPIModelsRequest, opts?: client.RequestOptions): Promise<GenerateBackendAPIModelsResponse>;
async getBackend(params: GetBackendRequest, opts?: client.RequestOptions): Promise<GetBackendResponse>;
async getBackendAPI(params: GetBackendAPIRequest, opts?: client.RequestOptions): Promise<GetBackendAPIResponse>;
async getBackendAPIModels(params: GetBackendAPIModelsRequest, opts?: client.RequestOptions): Promise<GetBackendAPIModelsResponse>;
async getBackendAuth(params: GetBackendAuthRequest, opts?: client.RequestOptions): Promise<GetBackendAuthResponse>;
async getBackendJob(params: GetBackendJobRequest, opts?: client.RequestOptions): Promise<GetBackendJobResponse>;
async getToken(params: GetTokenRequest, opts?: client.RequestOptions): Promise<GetTokenResponse>;
async importBackendAuth(params: ImportBackendAuthRequest, opts?: client.RequestOptions): Promise<ImportBackendAuthResponse>;
async listBackendJobs(params: ListBackendJobsRequest, opts?: client.RequestOptions): Promise<ListBackendJobsResponse>;
async removeAllBackends(params: RemoveAllBackendsRequest, opts?: client.RequestOptions): Promise<RemoveAllBackendsResponse>;
async removeBackendConfig(params: RemoveBackendConfigRequest, opts?: client.RequestOptions): Promise<RemoveBackendConfigResponse>;
async updateBackendAPI(params: UpdateBackendAPIRequest, opts?: client.RequestOptions): Promise<UpdateBackendAPIResponse>;
async updateBackendAuth(params: UpdateBackendAuthRequest, opts?: client.RequestOptions): Promise<UpdateBackendAuthResponse>;
async updateBackendConfig(params: UpdateBackendConfigRequest, opts?: client.RequestOptions): Promise<UpdateBackendConfigResponse>;
async updateBackendJob(params: UpdateBackendJobRequest, opts?: client.RequestOptions): Promise<UpdateBackendJobResponse>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new AmplifyBackend(apiFactory: client.ApiFactory)
[src]

§Methods

§
cloneBackend(params: CloneBackendRequest, opts?: client.RequestOptions): Promise<CloneBackendResponse>
[src]

This operation clones an existing backend.

§
createBackend(params: CreateBackendRequest, opts?: client.RequestOptions): Promise<CreateBackendResponse>
[src]

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

§
createBackendAPI(params: CreateBackendAPIRequest, opts?: client.RequestOptions): Promise<CreateBackendAPIResponse>
[src]

Creates a new backend API resource.

§
createBackendAuth(params: CreateBackendAuthRequest, opts?: client.RequestOptions): Promise<CreateBackendAuthResponse>
[src]

Creates a new backend authentication resource.

§
createBackendConfig(params: CreateBackendConfigRequest, opts?: client.RequestOptions): Promise<CreateBackendConfigResponse>
[src]

Creates a config object for a backend.

§
createToken(params: CreateTokenRequest, opts?: client.RequestOptions): Promise<CreateTokenResponse>
[src]

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

§
deleteBackend(params: DeleteBackendRequest, opts?: client.RequestOptions): Promise<DeleteBackendResponse>
[src]

Removes an existing environment from your Amplify project.

§
deleteBackendAPI(params: DeleteBackendAPIRequest, opts?: client.RequestOptions): Promise<DeleteBackendAPIResponse>
[src]

Deletes an existing backend API resource.

§
deleteBackendAuth(params: DeleteBackendAuthRequest, opts?: client.RequestOptions): Promise<DeleteBackendAuthResponse>
[src]

Deletes an existing backend authentication resource.

§
deleteToken(params: DeleteTokenRequest, opts?: client.RequestOptions): Promise<DeleteTokenResponse>
[src]

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

§
generateBackendAPIModels(params: GenerateBackendAPIModelsRequest, opts?: client.RequestOptions): Promise<GenerateBackendAPIModelsResponse>
[src]

Generates a model schema for an existing backend API resource.

§
getBackend(params: GetBackendRequest, opts?: client.RequestOptions): Promise<GetBackendResponse>
[src]

Provides project-level details for your Amplify UI project.

§
getBackendAPI(params: GetBackendAPIRequest, opts?: client.RequestOptions): Promise<GetBackendAPIResponse>
[src]

Gets the details for a backend API.

§
getBackendAPIModels(params: GetBackendAPIModelsRequest, opts?: client.RequestOptions): Promise<GetBackendAPIModelsResponse>
[src]

Generates a model schema for existing backend API resource.

§
getBackendAuth(params: GetBackendAuthRequest, opts?: client.RequestOptions): Promise<GetBackendAuthResponse>
[src]

Gets a backend auth details.

§
getBackendJob(params: GetBackendJobRequest, opts?: client.RequestOptions): Promise<GetBackendJobResponse>
[src]

Returns information about a specific job.

§
getToken(params: GetTokenRequest, opts?: client.RequestOptions): Promise<GetTokenResponse>
[src]

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

§
importBackendAuth(params: ImportBackendAuthRequest, opts?: client.RequestOptions): Promise<ImportBackendAuthResponse>
[src]

Imports an existing backend authentication resource.

§
listBackendJobs(params: ListBackendJobsRequest, opts?: client.RequestOptions): Promise<ListBackendJobsResponse>
[src]

Lists the jobs for the backend of an Amplify app.

§
removeAllBackends(params: RemoveAllBackendsRequest, opts?: client.RequestOptions): Promise<RemoveAllBackendsResponse>
[src]

Removes all backend environments from your Amplify project.

§
removeBackendConfig(params: RemoveBackendConfigRequest, opts?: client.RequestOptions): Promise<RemoveBackendConfigResponse>
[src]

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

§
updateBackendAPI(params: UpdateBackendAPIRequest, opts?: client.RequestOptions): Promise<UpdateBackendAPIResponse>
[src]

Updates an existing backend API resource.

§
updateBackendAuth(params: UpdateBackendAuthRequest, opts?: client.RequestOptions): Promise<UpdateBackendAuthResponse>
[src]

Updates an existing backend authentication resource.

§
updateBackendConfig(params: UpdateBackendConfigRequest, opts?: client.RequestOptions): Promise<UpdateBackendConfigResponse>
[src]

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

§
updateBackendJob(params: UpdateBackendJobRequest, opts?: client.RequestOptions): Promise<UpdateBackendJobResponse>
[src]

Updates a specific job.

§Static Properties