Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-amplify

Description

Amplify enables developers to develop and deploy cloud-powered mobile and web apps. Amplify Hosting provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Hosting User Guide . The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework.

Installation

NPM

npm install @aws-sdk/client-amplify

Yarn

yarn add @aws-sdk/client-amplify

pnpm

pnpm add @aws-sdk/client-amplify

Types

Type Name	Type
Amplify	Class
Amplify	Interface
AmplifyClient	Class
AmplifyClientConfig	Interface
AmplifyClientConfigType	TypeAlias
AmplifyClientResolvedConfig	Interface
AmplifyClientResolvedConfigType	TypeAlias
AmplifyPaginationConfiguration	Interface
AmplifyServiceException	Class
App	Interface
Artifact	Interface
AutoBranchCreationConfig	Interface
Backend	Interface
BackendEnvironment	Interface
BadRequestException	Class
Branch	Interface
CacheConfig	Interface
CacheConfigType	TypeAlias
CacheConfigTypeenum	Variable
Certificate	Interface
CertificateSettings	Interface
CertificateType	TypeAlias
CertificateTypeenum	Variable
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
CreateAppCommand	Class
CreateAppCommandInput	Interface
CreateAppCommandOutput	Interface
CreateAppRequest	Interface
CreateAppResult	Interface
CreateBackendEnvironmentCommand	Class
CreateBackendEnvironmentCommandInput	Interface
CreateBackendEnvironmentCommandOutput	Interface
CreateBackendEnvironmentRequest	Interface
CreateBackendEnvironmentResult	Interface
CreateBranchCommand	Class
CreateBranchCommandInput	Interface
CreateBranchCommandOutput	Interface
CreateBranchRequest	Interface
CreateBranchResult	Interface
CreateDeploymentCommand	Class
CreateDeploymentCommandInput	Interface
CreateDeploymentCommandOutput	Interface
CreateDeploymentRequest	Interface
CreateDeploymentResult	Interface
CreateDomainAssociationCommand	Class
CreateDomainAssociationCommandInput	Interface
CreateDomainAssociationCommandOutput	Interface
CreateDomainAssociationRequest	Interface
CreateDomainAssociationResult	Interface
CreateWebhookCommand	Class
CreateWebhookCommandInput	Interface
CreateWebhookCommandOutput	Interface
CreateWebhookRequest	Interface
CreateWebhookResult	Interface
CustomRule	Interface
DeleteAppCommand	Class
DeleteAppCommandInput	Interface
DeleteAppCommandOutput	Interface
DeleteAppRequest	Interface
DeleteAppResult	Interface
DeleteBackendEnvironmentCommand	Class
DeleteBackendEnvironmentCommandInput	Interface
DeleteBackendEnvironmentCommandOutput	Interface
DeleteBackendEnvironmentRequest	Interface
DeleteBackendEnvironmentResult	Interface
DeleteBranchCommand	Class
DeleteBranchCommandInput	Interface
DeleteBranchCommandOutput	Interface
DeleteBranchRequest	Interface
DeleteBranchResult	Interface
DeleteDomainAssociationCommand	Class
DeleteDomainAssociationCommandInput	Interface
DeleteDomainAssociationCommandOutput	Interface
DeleteDomainAssociationRequest	Interface
DeleteDomainAssociationResult	Interface
DeleteJobCommand	Class
DeleteJobCommandInput	Interface
DeleteJobCommandOutput	Interface
DeleteJobRequest	Interface
DeleteJobResult	Interface
DeleteWebhookCommand	Class
DeleteWebhookCommandInput	Interface
DeleteWebhookCommandOutput	Interface
DeleteWebhookRequest	Interface
DeleteWebhookResult	Interface
DependentServiceFailureException	Class
DomainAssociation	Interface
DomainStatus	TypeAlias
DomainStatusenum	Variable
GenerateAccessLogsCommand	Class
GenerateAccessLogsCommandInput	Interface
GenerateAccessLogsCommandOutput	Interface
GenerateAccessLogsRequest	Interface
GenerateAccessLogsResult	Interface
GetAppCommand	Class
GetAppCommandInput	Interface
GetAppCommandOutput	Interface
GetAppRequest	Interface
GetAppResult	Interface
GetArtifactUrlCommand	Class
GetArtifactUrlCommandInput	Interface
GetArtifactUrlCommandOutput	Interface
GetArtifactUrlRequest	Interface
GetArtifactUrlResult	Interface
GetBackendEnvironmentCommand	Class
GetBackendEnvironmentCommandInput	Interface
GetBackendEnvironmentCommandOutput	Interface
GetBackendEnvironmentRequest	Interface
GetBackendEnvironmentResult	Interface
GetBranchCommand	Class
GetBranchCommandInput	Interface
GetBranchCommandOutput	Interface
GetBranchRequest	Interface
GetBranchResult	Interface
GetDomainAssociationCommand	Class
GetDomainAssociationCommandInput	Interface
GetDomainAssociationCommandOutput	Interface
GetDomainAssociationRequest	Interface
GetDomainAssociationResult	Interface
GetJobCommand	Class
GetJobCommandInput	Interface
GetJobCommandOutput	Interface
GetJobRequest	Interface
GetJobResult	Interface
GetWebhookCommand	Class
GetWebhookCommandInput	Interface
GetWebhookCommandOutput	Interface
GetWebhookRequest	Interface
GetWebhookResult	Interface
InternalFailureException	Class
Job	Interface
JobStatus	TypeAlias
JobStatusenum	Variable
JobSummary	Interface
JobType	TypeAlias
JobTypeenum	Variable
LimitExceededException	Class
ListAppsCommand	Class
ListAppsCommandInput	Interface
ListAppsCommandOutput	Interface
ListAppsRequest	Interface
ListAppsResult	Interface
ListArtifactsCommand	Class
ListArtifactsCommandInput	Interface
ListArtifactsCommandOutput	Interface
ListArtifactsRequest	Interface
ListArtifactsResult	Interface
ListBackendEnvironmentsCommand	Class
ListBackendEnvironmentsCommandInput	Interface
ListBackendEnvironmentsCommandOutput	Interface
ListBackendEnvironmentsRequest	Interface
ListBackendEnvironmentsResult	Interface
ListBranchesCommand	Class
ListBranchesCommandInput	Interface
ListBranchesCommandOutput	Interface
ListBranchesRequest	Interface
ListBranchesResult	Interface
ListDomainAssociationsCommand	Class
ListDomainAssociationsCommandInput	Interface
ListDomainAssociationsCommandOutput	Interface
ListDomainAssociationsRequest	Interface
ListDomainAssociationsResult	Interface
ListJobsCommand	Class
ListJobsCommandInput	Interface
ListJobsCommandOutput	Interface
ListJobsRequest	Interface
ListJobsResult	Interface
ListTagsForResourceCommand	Class
ListTagsForResourceCommandInput	Interface
ListTagsForResourceCommandOutput	Interface
ListTagsForResourceRequest	Interface
ListTagsForResourceResponse	Interface
ListWebhooksCommand	Class
ListWebhooksCommandInput	Interface
ListWebhooksCommandOutput	Interface
ListWebhooksRequest	Interface
ListWebhooksResult	Interface
NotFoundException	Class
paginateListApps	Variable
paginateListBranches	Variable
paginateListDomainAssociations	Variable
paginateListJobs	Variable
Platform	TypeAlias
Platformenum	Variable
ProductionBranch	Interface
RepositoryCloneMethod	TypeAlias
RepositoryCloneMethodenum	Variable
ResourceNotFoundException	Class
RuntimeExtension	Interface
ServiceInputTypes	TypeAlias
ServiceOutputTypes	TypeAlias
SourceUrlType	TypeAlias
SourceUrlTypeenum	Variable
Stage	TypeAlias
Stageenum	Variable
StartDeploymentCommand	Class
StartDeploymentCommandInput	Interface
StartDeploymentCommandOutput	Interface
StartDeploymentRequest	Interface
StartDeploymentResult	Interface
StartJobCommand	Class
StartJobCommandInput	Interface
StartJobCommandOutput	Interface
StartJobRequest	Interface
StartJobResult	Interface
Step	Interface
StopJobCommand	Class
StopJobCommandInput	Interface
StopJobCommandOutput	Interface
StopJobRequest	Interface
StopJobResult	Interface
SubDomain	Interface
SubDomainSetting	Interface
TagResourceCommand	Class
TagResourceCommandInput	Interface
TagResourceCommandOutput	Interface
TagResourceRequest	Interface
TagResourceResponse	Interface
UnauthorizedException	Class
UntagResourceCommand	Class
UntagResourceCommandInput	Interface
UntagResourceCommandOutput	Interface
UntagResourceRequest	Interface
UntagResourceResponse	Interface
UpdateAppCommand	Class
UpdateAppCommandInput	Interface
UpdateAppCommandOutput	Interface
UpdateAppRequest	Interface
UpdateAppResult	Interface
UpdateBranchCommand	Class
UpdateBranchCommandInput	Interface
UpdateBranchCommandOutput	Interface
UpdateBranchRequest	Interface
UpdateBranchResult	Interface
UpdateDomainAssociationCommand	Class
UpdateDomainAssociationCommandInput	Interface
UpdateDomainAssociationCommandOutput	Interface
UpdateDomainAssociationRequest	Interface
UpdateDomainAssociationResult	Interface
UpdateStatus	TypeAlias
UpdateStatusenum	Variable
UpdateWebhookCommand	Class
UpdateWebhookCommandInput	Interface
UpdateWebhookCommandOutput	Interface
UpdateWebhookRequest	Interface
UpdateWebhookResult	Interface
WafConfiguration	Interface
WafStatus	TypeAlias
WafStatusenum	Variable
Webhook	Interface

Getting Started

References

@aws-sdk/client-amplify

Description

Installation

Types

Table of Contents

Search