- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
AmplifyClient
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 install @aws-sdk/client-amplifyyarn add @aws-sdk/client-amplifypnpm add @aws-sdk/client-amplifyAmplifyClient Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| CreateAppCommand | Creates a new Amplify app. |
| CreateBackendEnvironmentCommand | 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. |
| CreateBranchCommand | Creates a new branch for an Amplify app. |
| CreateDeploymentCommand | Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a Git repository. The maximum duration between the |
| CreateDomainAssociationCommand | Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app |
| CreateWebhookCommand | Creates a new webhook on an Amplify app. |
| DeleteAppCommand | Deletes an existing Amplify app specified by an app ID. |
| DeleteBackendEnvironmentCommand | Deletes a 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. |
| DeleteBranchCommand | Deletes a branch for an Amplify app. |
| DeleteDomainAssociationCommand | Deletes a domain association for an Amplify app. |
| DeleteJobCommand | Deletes a job for a branch of an Amplify app. |
| DeleteWebhookCommand | Deletes a webhook. |
| GenerateAccessLogsCommand | Returns the website access logs for a specific time range using a presigned URL. |
| GetAppCommand | Returns an existing Amplify app specified by an app ID. |
| GetArtifactUrlCommand | Returns the artifact info that corresponds to an artifact id. |
| GetBackendEnvironmentCommand | Returns a 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. |
| GetBranchCommand | Returns a branch for an Amplify app. |
| GetDomainAssociationCommand | Returns the domain information for an Amplify app. |
| GetJobCommand | Returns a job for a branch of an Amplify app. |
| GetWebhookCommand | Returns the webhook information that corresponds to a specified webhook ID. |
| ListAppsCommand | Returns a list of the existing Amplify apps. |
| ListArtifactsCommand | Returns a list of artifacts for a specified app, branch, and job. |
| ListBackendEnvironmentsCommand | Lists the backend environments 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. |
| ListBranchesCommand | Lists the branches of an Amplify app. |
| ListDomainAssociationsCommand | Returns the domain associations for an Amplify app. |
| ListJobsCommand | Lists the jobs for a branch of an Amplify app. |
| ListTagsForResourceCommand | Returns a list of tags for a specified Amazon Resource Name (ARN). |
| ListWebhooksCommand | Returns a list of webhooks for an Amplify app. |
| StartDeploymentCommand | Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git repository. The maximum duration between the |
| StartJobCommand | Starts a new job for a branch of an Amplify app. |
| StopJobCommand | Stops a job that is in progress for a branch of an Amplify app. |
| TagResourceCommand | Tags the resource with a tag key and value. |
| UntagResourceCommand | Untags a resource with a specified Amazon Resource Name (ARN). |
| UpdateAppCommand | Updates an existing Amplify app. |
| UpdateBranchCommand | Updates a branch for an Amplify app. |
| UpdateDomainAssociationCommand | Creates a new domain association for an Amplify app. |
| UpdateWebhookCommand | Updates a webhook. |
AmplifyClient Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: AmplifyClientConfig