AmplifyBackend

import { AmplifyBackend } from "https://aws-api.deno.dev/v0.1/services/amplifybackend.ts?docs=full";

class AmplifyBackend {

constructor(apiFactory: client.ApiFactory);

async cloneBackend(params: CloneBackendRequest): Promise<CloneBackendResponse>;

async createBackend(params: CreateBackendRequest): Promise<CreateBackendResponse>;

async createBackendAPI(params: CreateBackendAPIRequest): Promise<CreateBackendAPIResponse>;

async createBackendAuth(params: CreateBackendAuthRequest): Promise<CreateBackendAuthResponse>;

async createBackendConfig(params: CreateBackendConfigRequest): Promise<CreateBackendConfigResponse>;

async createToken(params: CreateTokenRequest): Promise<CreateTokenResponse>;

async deleteBackend(params: DeleteBackendRequest): Promise<DeleteBackendResponse>;

async deleteBackendAPI(params: DeleteBackendAPIRequest): Promise<DeleteBackendAPIResponse>;

async deleteBackendAuth(params: DeleteBackendAuthRequest): Promise<DeleteBackendAuthResponse>;

async deleteToken(params: DeleteTokenRequest): Promise<DeleteTokenResponse>;

async generateBackendAPIModels(params: GenerateBackendAPIModelsRequest): Promise<GenerateBackendAPIModelsResponse>;

async getBackend(params: GetBackendRequest): Promise<GetBackendResponse>;

async getBackendAPI(params: GetBackendAPIRequest): Promise<GetBackendAPIResponse>;

async getBackendAPIModels(params: GetBackendAPIModelsRequest): Promise<GetBackendAPIModelsResponse>;

async getBackendAuth(params: GetBackendAuthRequest): Promise<GetBackendAuthResponse>;

async getBackendJob(params: GetBackendJobRequest): Promise<GetBackendJobResponse>;

async getToken(params: GetTokenRequest): Promise<GetTokenResponse>;

async listBackendJobs(params: ListBackendJobsRequest): Promise<ListBackendJobsResponse>;

async removeAllBackends(params: RemoveAllBackendsRequest): Promise<RemoveAllBackendsResponse>;

async removeBackendConfig(params: RemoveBackendConfigRequest): Promise<RemoveBackendConfigResponse>;

async updateBackendAPI(params: UpdateBackendAPIRequest): Promise<UpdateBackendAPIResponse>;

async updateBackendAuth(params: UpdateBackendAuthRequest): Promise<UpdateBackendAuthResponse>;

async updateBackendConfig(params: UpdateBackendConfigRequest): Promise<UpdateBackendConfigResponse>;

async updateBackendJob(params: UpdateBackendJobRequest): Promise<UpdateBackendJobResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new AmplifyBackend(apiFactory: client.ApiFactory)

[src]

§Methods

cloneBackend(params: CloneBackendRequest): Promise<CloneBackendResponse>

[src]

This operation clones an existing backend.

createBackend(params: CreateBackendRequest): 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): Promise<CreateBackendAPIResponse>

[src]

Creates a new backend API resource.

createBackendAuth(params: CreateBackendAuthRequest): Promise<CreateBackendAuthResponse>

[src]

Creates a new backend authentication resource.

createBackendConfig(params: CreateBackendConfigRequest): Promise<CreateBackendConfigResponse>

[src]

Creates a config object for a backend.

createToken(params: CreateTokenRequest): Promise<CreateTokenResponse>

[src]

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

deleteBackend(params: DeleteBackendRequest): Promise<DeleteBackendResponse>

[src]

Removes an existing environment from your Amplify project.

deleteBackendAPI(params: DeleteBackendAPIRequest): Promise<DeleteBackendAPIResponse>

[src]

Deletes an existing backend API resource.

deleteBackendAuth(params: DeleteBackendAuthRequest): Promise<DeleteBackendAuthResponse>

[src]

Deletes an existing backend authentication resource.

deleteToken(params: DeleteTokenRequest): Promise<DeleteTokenResponse>

[src]

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

generateBackendAPIModels(params: GenerateBackendAPIModelsRequest): Promise<GenerateBackendAPIModelsResponse>

[src]

Generates a model schema for an existing backend API resource.

getBackend(params: GetBackendRequest): Promise<GetBackendResponse>

[src]

Provides project-level details for your Amplify UI project.

getBackendAPI(params: GetBackendAPIRequest): Promise<GetBackendAPIResponse>

[src]

Gets the details for a backend API.

getBackendAPIModels(params: GetBackendAPIModelsRequest): Promise<GetBackendAPIModelsResponse>

[src]

Generates a model schema for existing backend API resource.

getBackendAuth(params: GetBackendAuthRequest): Promise<GetBackendAuthResponse>

[src]

Gets backend auth details.

getBackendJob(params: GetBackendJobRequest): Promise<GetBackendJobResponse>

[src]

Returns information about a specific job.

getToken(params: GetTokenRequest): Promise<GetTokenResponse>

[src]

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

listBackendJobs(params: ListBackendJobsRequest): Promise<ListBackendJobsResponse>

[src]

Lists the jobs for the backend of an Amplify app.

removeAllBackends(params: RemoveAllBackendsRequest): Promise<RemoveAllBackendsResponse>

[src]

Removes all backend environments from your Amplify project.

removeBackendConfig(params: RemoveBackendConfigRequest): Promise<RemoveBackendConfigResponse>

[src]

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

updateBackendAPI(params: UpdateBackendAPIRequest): Promise<UpdateBackendAPIResponse>

[src]

Updates an existing backend API resource.

updateBackendAuth(params: UpdateBackendAuthRequest): Promise<UpdateBackendAuthResponse>

[src]

Updates an existing backend authentication resource.

updateBackendConfig(params: UpdateBackendConfigRequest): Promise<UpdateBackendConfigResponse>

[src]

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

updateBackendJob(params: UpdateBackendJobRequest): Promise<UpdateBackendJobResponse>

[src]

Updates a specific job.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]