Amplify

import { Amplify } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/amplify.ts?docs=full";

class Amplify {

constructor(apiFactory: client.ApiFactory);

async createApp(params: CreateAppRequest, opts?: client.RequestOptions): Promise<CreateAppResult>;

async createBackendEnvironment(params: CreateBackendEnvironmentRequest, opts?: client.RequestOptions): Promise<CreateBackendEnvironmentResult>;

async createBranch(params: CreateBranchRequest, opts?: client.RequestOptions): Promise<CreateBranchResult>;

async createDeployment(params: CreateDeploymentRequest, opts?: client.RequestOptions): Promise<CreateDeploymentResult>;

async createDomainAssociation(params: CreateDomainAssociationRequest, opts?: client.RequestOptions): Promise<CreateDomainAssociationResult>;

async createWebhook(params: CreateWebhookRequest, opts?: client.RequestOptions): Promise<CreateWebhookResult>;

async deleteApp(params: DeleteAppRequest, opts?: client.RequestOptions): Promise<DeleteAppResult>;

async deleteBackendEnvironment(params: DeleteBackendEnvironmentRequest, opts?: client.RequestOptions): Promise<DeleteBackendEnvironmentResult>;

async deleteBranch(params: DeleteBranchRequest, opts?: client.RequestOptions): Promise<DeleteBranchResult>;

async deleteDomainAssociation(params: DeleteDomainAssociationRequest, opts?: client.RequestOptions): Promise<DeleteDomainAssociationResult>;

async deleteJob(params: DeleteJobRequest, opts?: client.RequestOptions): Promise<DeleteJobResult>;

async deleteWebhook(params: DeleteWebhookRequest, opts?: client.RequestOptions): Promise<DeleteWebhookResult>;

async generateAccessLogs(params: GenerateAccessLogsRequest, opts?: client.RequestOptions): Promise<GenerateAccessLogsResult>;

async getApp(params: GetAppRequest, opts?: client.RequestOptions): Promise<GetAppResult>;

async getArtifactUrl(params: GetArtifactUrlRequest, opts?: client.RequestOptions): Promise<GetArtifactUrlResult>;

async getBackendEnvironment(params: GetBackendEnvironmentRequest, opts?: client.RequestOptions): Promise<GetBackendEnvironmentResult>;

async getBranch(params: GetBranchRequest, opts?: client.RequestOptions): Promise<GetBranchResult>;

async getDomainAssociation(params: GetDomainAssociationRequest, opts?: client.RequestOptions): Promise<GetDomainAssociationResult>;

async getJob(params: GetJobRequest, opts?: client.RequestOptions): Promise<GetJobResult>;

async getWebhook(params: GetWebhookRequest, opts?: client.RequestOptions): Promise<GetWebhookResult>;

async listApps(params?: ListAppsRequest, opts?: client.RequestOptions): Promise<ListAppsResult>;

async listArtifacts(params: ListArtifactsRequest, opts?: client.RequestOptions): Promise<ListArtifactsResult>;

async listBackendEnvironments(params: ListBackendEnvironmentsRequest, opts?: client.RequestOptions): Promise<ListBackendEnvironmentsResult>;

async listBranches(params: ListBranchesRequest, opts?: client.RequestOptions): Promise<ListBranchesResult>;

async listDomainAssociations(params: ListDomainAssociationsRequest, opts?: client.RequestOptions): Promise<ListDomainAssociationsResult>;

async listJobs(params: ListJobsRequest, opts?: client.RequestOptions): Promise<ListJobsResult>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listWebhooks(params: ListWebhooksRequest, opts?: client.RequestOptions): Promise<ListWebhooksResult>;

async startDeployment(params: StartDeploymentRequest, opts?: client.RequestOptions): Promise<StartDeploymentResult>;

async startJob(params: StartJobRequest, opts?: client.RequestOptions): Promise<StartJobResult>;

async stopJob(params: StopJobRequest, opts?: client.RequestOptions): Promise<StopJobResult>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateApp(params: UpdateAppRequest, opts?: client.RequestOptions): Promise<UpdateAppResult>;

async updateBranch(params: UpdateBranchRequest, opts?: client.RequestOptions): Promise<UpdateBranchResult>;

async updateDomainAssociation(params: UpdateDomainAssociationRequest, opts?: client.RequestOptions): Promise<UpdateDomainAssociationResult>;

async updateWebhook(params: UpdateWebhookRequest, opts?: client.RequestOptions): Promise<UpdateWebhookResult>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Amplify(apiFactory: client.ApiFactory)

[src]

§Methods

createApp(params: CreateAppRequest, opts?: client.RequestOptions): Promise<CreateAppResult>

[src]

Creates a new Amplify app.

createBackendEnvironment(params: CreateBackendEnvironmentRequest, opts?: client.RequestOptions): Promise<CreateBackendEnvironmentResult>

[src]

Creates a new backend environment for an Amplify app.

This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

createBranch(params: CreateBranchRequest, opts?: client.RequestOptions): Promise<CreateBranchResult>

[src]

Creates a new branch for an Amplify app.

createDeployment(params: CreateDeploymentRequest, opts?: client.RequestOptions): Promise<CreateDeploymentResult>

[src]

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.

The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.

createDomainAssociation(params: CreateDomainAssociationRequest, opts?: client.RequestOptions): Promise<CreateDomainAssociationResult>

[src]

Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app

createWebhook(params: CreateWebhookRequest, opts?: client.RequestOptions): Promise<CreateWebhookResult>

[src]

Creates a new webhook on an Amplify app.

deleteApp(params: DeleteAppRequest, opts?: client.RequestOptions): Promise<DeleteAppResult>

[src]

Deletes an existing Amplify app specified by an app ID.

deleteBackendEnvironment(params: DeleteBackendEnvironmentRequest, opts?: client.RequestOptions): Promise<DeleteBackendEnvironmentResult>

[src]

Deletes a backend environment for an Amplify app.

deleteBranch(params: DeleteBranchRequest, opts?: client.RequestOptions): Promise<DeleteBranchResult>

[src]

Deletes a branch for an Amplify app.

deleteDomainAssociation(params: DeleteDomainAssociationRequest, opts?: client.RequestOptions): Promise<DeleteDomainAssociationResult>

[src]

Deletes a domain association for an Amplify app.

deleteJob(params: DeleteJobRequest, opts?: client.RequestOptions): Promise<DeleteJobResult>

[src]

Deletes a job for a branch of an Amplify app.

deleteWebhook(params: DeleteWebhookRequest, opts?: client.RequestOptions): Promise<DeleteWebhookResult>

[src]

Deletes a webhook.

generateAccessLogs(params: GenerateAccessLogsRequest, opts?: client.RequestOptions): Promise<GenerateAccessLogsResult>

[src]

Returns the website access logs for a specific time range using a presigned URL.

getApp(params: GetAppRequest, opts?: client.RequestOptions): Promise<GetAppResult>

[src]

Returns an existing Amplify app specified by an app ID.

getArtifactUrl(params: GetArtifactUrlRequest, opts?: client.RequestOptions): Promise<GetArtifactUrlResult>

[src]

Returns the artifact info that corresponds to an artifact id.

getBackendEnvironment(params: GetBackendEnvironmentRequest, opts?: client.RequestOptions): Promise<GetBackendEnvironmentResult>

[src]

Returns a backend environment for an Amplify app.

getBranch(params: GetBranchRequest, opts?: client.RequestOptions): Promise<GetBranchResult>

[src]

Returns a branch for an Amplify app.

getDomainAssociation(params: GetDomainAssociationRequest, opts?: client.RequestOptions): Promise<GetDomainAssociationResult>

[src]

Returns the domain information for an Amplify app.

getJob(params: GetJobRequest, opts?: client.RequestOptions): Promise<GetJobResult>

[src]

Returns a job for a branch of an Amplify app.

getWebhook(params: GetWebhookRequest, opts?: client.RequestOptions): Promise<GetWebhookResult>

[src]

Returns the webhook information that corresponds to a specified webhook ID.

listApps(params?: ListAppsRequest, opts?: client.RequestOptions): Promise<ListAppsResult>

[src]

Returns a list of the existing Amplify apps.

listArtifacts(params: ListArtifactsRequest, opts?: client.RequestOptions): Promise<ListArtifactsResult>

[src]

Returns a list of artifacts for a specified app, branch, and job.

listBackendEnvironments(params: ListBackendEnvironmentsRequest, opts?: client.RequestOptions): Promise<ListBackendEnvironmentsResult>

[src]

Lists the backend environments for an Amplify app.

listBranches(params: ListBranchesRequest, opts?: client.RequestOptions): Promise<ListBranchesResult>

[src]

Lists the branches of an Amplify app.

listDomainAssociations(params: ListDomainAssociationsRequest, opts?: client.RequestOptions): Promise<ListDomainAssociationsResult>

[src]

Returns the domain associations for an Amplify app.

listJobs(params: ListJobsRequest, opts?: client.RequestOptions): Promise<ListJobsResult>

[src]

Lists the jobs for a branch of an Amplify app.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Returns a list of tags for a specified Amazon Resource Name (ARN).

listWebhooks(params: ListWebhooksRequest, opts?: client.RequestOptions): Promise<ListWebhooksResult>

[src]

Returns a list of webhooks for an Amplify app.

startDeployment(params: StartDeploymentRequest, opts?: client.RequestOptions): Promise<StartDeploymentResult>

[src]

Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.

startJob(params: StartJobRequest, opts?: client.RequestOptions): Promise<StartJobResult>

[src]

Starts a new job for a branch of an Amplify app.

stopJob(params: StopJobRequest, opts?: client.RequestOptions): Promise<StopJobResult>

[src]

Stops a job that is in progress for a branch of an Amplify app.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Tags the resource with a tag key and value.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Untags a resource with a specified Amazon Resource Name (ARN).

updateApp(params: UpdateAppRequest, opts?: client.RequestOptions): Promise<UpdateAppResult>

[src]

Updates an existing Amplify app.

updateBranch(params: UpdateBranchRequest, opts?: client.RequestOptions): Promise<UpdateBranchResult>

[src]

Updates a branch for an Amplify app.

updateDomainAssociation(params: UpdateDomainAssociationRequest, opts?: client.RequestOptions): Promise<UpdateDomainAssociationResult>

[src]

Creates a new domain association for an Amplify app.

updateWebhook(params: UpdateWebhookRequest, opts?: client.RequestOptions): Promise<UpdateWebhookResult>

[src]

Updates a webhook.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]