AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Implementation for accessing Amplify
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.Namespace: Amazon.Amplify
Assembly: AWSSDK.Amplify.dll
Version: 3.x.y.z
public class AmazonAmplifyClient : AmazonServiceClient IAmazonAmplify, IAmazonService, IDisposable
The AmazonAmplifyClient type exposes the following members
Name | Description | |
---|---|---|
AmazonAmplifyClient() |
Constructs AmazonAmplifyClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonAmplifyClient(RegionEndpoint) |
Constructs AmazonAmplifyClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonAmplifyClient(AmazonAmplifyConfig) |
Constructs AmazonAmplifyClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonAmplifyClient(AWSCredentials) |
Constructs AmazonAmplifyClient with AWS Credentials |
|
AmazonAmplifyClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonAmplifyClient with AWS Credentials |
|
AmazonAmplifyClient(AWSCredentials, AmazonAmplifyConfig) |
Constructs AmazonAmplifyClient with AWS Credentials and an AmazonAmplifyClient Configuration object. |
|
AmazonAmplifyClient(string, string) |
Constructs AmazonAmplifyClient with AWS Access Key ID and AWS Secret Key |
|
AmazonAmplifyClient(string, string, RegionEndpoint) |
Constructs AmazonAmplifyClient with AWS Access Key ID and AWS Secret Key |
|
AmazonAmplifyClient(string, string, AmazonAmplifyConfig) |
Constructs AmazonAmplifyClient with AWS Access Key ID, AWS Secret Key and an AmazonAmplifyClient Configuration object. |
|
AmazonAmplifyClient(string, string, string) |
Constructs AmazonAmplifyClient with AWS Access Key ID and AWS Secret Key |
|
AmazonAmplifyClient(string, string, string, RegionEndpoint) |
Constructs AmazonAmplifyClient with AWS Access Key ID and AWS Secret Key |
|
AmazonAmplifyClient(string, string, string, AmazonAmplifyConfig) |
Constructs AmazonAmplifyClient with AWS Access Key ID, AWS Secret Key and an AmazonAmplifyClient Configuration object. |
Name | Type | Description | |
---|---|---|---|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. | |
Paginators | Amazon.Amplify.Model.IAmplifyPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
CreateApp(CreateAppRequest) |
Creates a new Amplify app. |
|
CreateAppAsync(CreateAppRequest, CancellationToken) |
Creates a new Amplify app. |
|
CreateBackendEnvironment(CreateBackendEnvironmentRequest) |
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 applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. |
|
CreateBackendEnvironmentAsync(CreateBackendEnvironmentRequest, CancellationToken) |
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 applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. |
|
CreateBranch(CreateBranchRequest) |
Creates a new branch for an Amplify app. |
|
CreateBranchAsync(CreateBranchRequest, CancellationToken) |
Creates a new branch for an Amplify app. |
|
CreateDeployment(CreateDeploymentRequest) |
Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
The maximum duration between the |
|
CreateDeploymentAsync(CreateDeploymentRequest, CancellationToken) |
Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
The maximum duration between the |
|
CreateDomainAssociation(CreateDomainAssociationRequest) |
Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app |
|
CreateDomainAssociationAsync(CreateDomainAssociationRequest, CancellationToken) |
Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app |
|
CreateWebhook(CreateWebhookRequest) |
Creates a new webhook on an Amplify app. |
|
CreateWebhookAsync(CreateWebhookRequest, CancellationToken) |
Creates a new webhook on an Amplify app. |
|
DeleteApp(DeleteAppRequest) |
Deletes an existing Amplify app specified by an app ID. |
|
DeleteAppAsync(DeleteAppRequest, CancellationToken) |
Deletes an existing Amplify app specified by an app ID. |
|
DeleteBackendEnvironment(DeleteBackendEnvironmentRequest) |
Deletes a backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. |
|
DeleteBackendEnvironmentAsync(DeleteBackendEnvironmentRequest, CancellationToken) |
Deletes a backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. |
|
DeleteBranch(DeleteBranchRequest) |
Deletes a branch for an Amplify app. |
|
DeleteBranchAsync(DeleteBranchRequest, CancellationToken) |
Deletes a branch for an Amplify app. |
|
DeleteDomainAssociation(DeleteDomainAssociationRequest) |
Deletes a domain association for an Amplify app. |
|
DeleteDomainAssociationAsync(DeleteDomainAssociationRequest, CancellationToken) |
Deletes a domain association for an Amplify app. |
|
DeleteJob(DeleteJobRequest) |
Deletes a job for a branch of an Amplify app. |
|
DeleteJobAsync(DeleteJobRequest, CancellationToken) |
Deletes a job for a branch of an Amplify app. |
|
DeleteWebhook(DeleteWebhookRequest) |
Deletes a webhook. |
|
DeleteWebhookAsync(DeleteWebhookRequest, CancellationToken) |
Deletes a webhook. |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
GenerateAccessLogs(GenerateAccessLogsRequest) |
Returns the website access logs for a specific time range using a presigned URL. |
|
GenerateAccessLogsAsync(GenerateAccessLogsRequest, CancellationToken) |
Returns the website access logs for a specific time range using a presigned URL. |
|
GetApp(GetAppRequest) |
Returns an existing Amplify app specified by an app ID. |
|
GetAppAsync(GetAppRequest, CancellationToken) |
Returns an existing Amplify app specified by an app ID. |
|
GetArtifactUrl(GetArtifactUrlRequest) |
Returns the artifact info that corresponds to an artifact id. |
|
GetArtifactUrlAsync(GetArtifactUrlRequest, CancellationToken) |
Returns the artifact info that corresponds to an artifact id. |
|
GetBackendEnvironment(GetBackendEnvironmentRequest) |
Returns a backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. |
|
GetBackendEnvironmentAsync(GetBackendEnvironmentRequest, CancellationToken) |
Returns a backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. |
|
GetBranch(GetBranchRequest) |
Returns a branch for an Amplify app. |
|
GetBranchAsync(GetBranchRequest, CancellationToken) |
Returns a branch for an Amplify app. |
|
GetDomainAssociation(GetDomainAssociationRequest) |
Returns the domain information for an Amplify app. |
|
GetDomainAssociationAsync(GetDomainAssociationRequest, CancellationToken) |
Returns the domain information for an Amplify app. |
|
GetJob(GetJobRequest) |
Returns a job for a branch of an Amplify app. |
|
GetJobAsync(GetJobRequest, CancellationToken) |
Returns a job for a branch of an Amplify app. |
|
GetWebhook(GetWebhookRequest) |
Returns the webhook information that corresponds to a specified webhook ID. |
|
GetWebhookAsync(GetWebhookRequest, CancellationToken) |
Returns the webhook information that corresponds to a specified webhook ID. |
|
ListApps(ListAppsRequest) |
Returns a list of the existing Amplify apps. |
|
ListAppsAsync(ListAppsRequest, CancellationToken) |
Returns a list of the existing Amplify apps. |
|
ListArtifacts(ListArtifactsRequest) |
Returns a list of artifacts for a specified app, branch, and job. |
|
ListArtifactsAsync(ListArtifactsRequest, CancellationToken) |
Returns a list of artifacts for a specified app, branch, and job. |
|
ListBackendEnvironments(ListBackendEnvironmentsRequest) |
Lists the backend environments for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. |
|
ListBackendEnvironmentsAsync(ListBackendEnvironmentsRequest, CancellationToken) |
Lists the backend environments for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. |
|
ListBranches(ListBranchesRequest) |
Lists the branches of an Amplify app. |
|
ListBranchesAsync(ListBranchesRequest, CancellationToken) |
Lists the branches of an Amplify app. |
|
ListDomainAssociations(ListDomainAssociationsRequest) |
Returns the domain associations for an Amplify app. |
|
ListDomainAssociationsAsync(ListDomainAssociationsRequest, CancellationToken) |
Returns the domain associations for an Amplify app. |
|
ListJobs(ListJobsRequest) |
Lists the jobs for a branch of an Amplify app. |
|
ListJobsAsync(ListJobsRequest, CancellationToken) |
Lists the jobs for a branch of an Amplify app. |
|
ListTagsForResource(ListTagsForResourceRequest) |
Returns a list of tags for a specified Amazon Resource Name (ARN). |
|
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) |
Returns a list of tags for a specified Amazon Resource Name (ARN). |
|
ListWebhooks(ListWebhooksRequest) |
Returns a list of webhooks for an Amplify app. |
|
ListWebhooksAsync(ListWebhooksRequest, CancellationToken) |
Returns a list of webhooks for an Amplify app. |
|
StartDeployment(StartDeploymentRequest) |
Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
The maximum duration between the |
|
StartDeploymentAsync(StartDeploymentRequest, CancellationToken) |
Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
The maximum duration between the |
|
StartJob(StartJobRequest) |
Starts a new job for a branch of an Amplify app. |
|
StartJobAsync(StartJobRequest, CancellationToken) |
Starts a new job for a branch of an Amplify app. |
|
StopJob(StopJobRequest) |
Stops a job that is in progress for a branch of an Amplify app. |
|
StopJobAsync(StopJobRequest, CancellationToken) |
Stops a job that is in progress for a branch of an Amplify app. |
|
TagResource(TagResourceRequest) |
Tags the resource with a tag key and value. |
|
TagResourceAsync(TagResourceRequest, CancellationToken) |
Tags the resource with a tag key and value. |
|
UntagResource(UntagResourceRequest) |
Untags a resource with a specified Amazon Resource Name (ARN). |
|
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
Untags a resource with a specified Amazon Resource Name (ARN). |
|
UpdateApp(UpdateAppRequest) |
Updates an existing Amplify app. |
|
UpdateAppAsync(UpdateAppRequest, CancellationToken) |
Updates an existing Amplify app. |
|
UpdateBranch(UpdateBranchRequest) |
Updates a branch for an Amplify app. |
|
UpdateBranchAsync(UpdateBranchRequest, CancellationToken) |
Updates a branch for an Amplify app. |
|
UpdateDomainAssociation(UpdateDomainAssociationRequest) |
Creates a new domain association for an Amplify app. |
|
UpdateDomainAssociationAsync(UpdateDomainAssociationRequest, CancellationToken) |
Creates a new domain association for an Amplify app. |
|
UpdateWebhook(UpdateWebhookRequest) |
Updates a webhook. |
|
UpdateWebhookAsync(UpdateWebhookRequest, CancellationToken) |
Updates a webhook. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5