AWS SDK Version 3 for .NET
API Reference

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 is a fully managed continuous deployment and hosting service for modern web apps.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.Amplify.AmazonAmplifyClient

Namespace: Amazon.Amplify
Assembly: AWSSDK.Amplify.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonAmplifyClient : AmazonServiceClient
         IAmazonAmplify, IAmazonService, IDisposable

The AmazonAmplifyClient type exposes the following members

Constructors

NameDescription
Public Method 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.



    
        
    

             

Public Method 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.



    
        
    

             

Public Method 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.



    
        
    

             

Public Method AmazonAmplifyClient(AWSCredentials)

Constructs AmazonAmplifyClient with AWS Credentials

Public Method AmazonAmplifyClient(AWSCredentials, RegionEndpoint)

Constructs AmazonAmplifyClient with AWS Credentials

Public Method AmazonAmplifyClient(AWSCredentials, AmazonAmplifyConfig)

Constructs AmazonAmplifyClient with AWS Credentials and an AmazonAmplifyClient Configuration object.

Public Method AmazonAmplifyClient(string, string)

Constructs AmazonAmplifyClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAmplifyClient(string, string, RegionEndpoint)

Constructs AmazonAmplifyClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAmplifyClient(string, string, AmazonAmplifyConfig)

Constructs AmazonAmplifyClient with AWS Access Key ID, AWS Secret Key and an AmazonAmplifyClient Configuration object.

Public Method AmazonAmplifyClient(string, string, string)

Constructs AmazonAmplifyClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAmplifyClient(string, string, string, RegionEndpoint)

Constructs AmazonAmplifyClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAmplifyClient(string, string, string, AmazonAmplifyConfig)

Constructs AmazonAmplifyClient with AWS Access Key ID, AWS Secret Key and an AmazonAmplifyClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateApp(CreateAppRequest)

Creates a new Amplify App.

Public Method CreateAppAsync(CreateAppRequest, CancellationToken)

Creates a new Amplify App.

Public Method CreateBackendEnvironment(CreateBackendEnvironmentRequest)

Creates a new backend environment for an Amplify App.

Public Method CreateBackendEnvironmentAsync(CreateBackendEnvironmentRequest, CancellationToken)

Creates a new backend environment for an Amplify App.

Public Method CreateBranch(CreateBranchRequest)

Creates a new Branch for an Amplify App.

Public Method CreateBranchAsync(CreateBranchRequest, CancellationToken)

Creates a new Branch for an Amplify App.

Public Method CreateDeployment(CreateDeploymentRequest)

Create a deployment for manual deploy apps. (Apps are not connected to repository)

Public Method CreateDeploymentAsync(CreateDeploymentRequest, CancellationToken)

Create a deployment for manual deploy apps. (Apps are not connected to repository)

Public Method CreateDomainAssociation(CreateDomainAssociationRequest)

Create a new DomainAssociation on an App

Public Method CreateDomainAssociationAsync(CreateDomainAssociationRequest, CancellationToken)

Create a new DomainAssociation on an App

Public Method CreateWebhook(CreateWebhookRequest)

Create a new webhook on an App.

Public Method CreateWebhookAsync(CreateWebhookRequest, CancellationToken)

Create a new webhook on an App.

Public Method DeleteApp(DeleteAppRequest)

Delete an existing Amplify App by appId.

Public Method DeleteAppAsync(DeleteAppRequest, CancellationToken)

Delete an existing Amplify App by appId.

Public Method DeleteBackendEnvironment(DeleteBackendEnvironmentRequest)

Delete backend environment for an Amplify App.

Public Method DeleteBackendEnvironmentAsync(DeleteBackendEnvironmentRequest, CancellationToken)

Delete backend environment for an Amplify App.

Public Method DeleteBranch(DeleteBranchRequest)

Deletes a branch for an Amplify App.

Public Method DeleteBranchAsync(DeleteBranchRequest, CancellationToken)

Deletes a branch for an Amplify App.

Public Method DeleteDomainAssociation(DeleteDomainAssociationRequest)

Deletes a DomainAssociation.

Public Method DeleteDomainAssociationAsync(DeleteDomainAssociationRequest, CancellationToken)

Deletes a DomainAssociation.

Public Method DeleteJob(DeleteJobRequest)

Delete a job, for an Amplify branch, part of Amplify App.

Public Method DeleteJobAsync(DeleteJobRequest, CancellationToken)

Delete a job, for an Amplify branch, part of Amplify App.

Public Method DeleteWebhook(DeleteWebhookRequest)

Deletes a webhook.

Public Method DeleteWebhookAsync(DeleteWebhookRequest, CancellationToken)

Deletes a webhook.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GenerateAccessLogs(GenerateAccessLogsRequest)

Retrieve website access logs for a specific time range via a pre-signed URL.

Public Method GenerateAccessLogsAsync(GenerateAccessLogsRequest, CancellationToken)

Retrieve website access logs for a specific time range via a pre-signed URL.

Public Method GetApp(GetAppRequest)

Retrieves an existing Amplify App by appId.

Public Method GetAppAsync(GetAppRequest, CancellationToken)

Retrieves an existing Amplify App by appId.

Public Method GetArtifactUrl(GetArtifactUrlRequest)

Retrieves artifact info that corresponds to a artifactId.

Public Method GetArtifactUrlAsync(GetArtifactUrlRequest, CancellationToken)

Retrieves artifact info that corresponds to a artifactId.

Public Method GetBackendEnvironment(GetBackendEnvironmentRequest)

Retrieves a backend environment for an Amplify App.

Public Method GetBackendEnvironmentAsync(GetBackendEnvironmentRequest, CancellationToken)

Retrieves a backend environment for an Amplify App.

Public Method GetBranch(GetBranchRequest)

Retrieves a branch for an Amplify App.

Public Method GetBranchAsync(GetBranchRequest, CancellationToken)

Retrieves a branch for an Amplify App.

Public Method GetDomainAssociation(GetDomainAssociationRequest)

Retrieves domain info that corresponds to an appId and domainName.

Public Method GetDomainAssociationAsync(GetDomainAssociationRequest, CancellationToken)

Retrieves domain info that corresponds to an appId and domainName.

Public Method GetJob(GetJobRequest)

Get a job for a branch, part of an Amplify App.

Public Method GetJobAsync(GetJobRequest, CancellationToken)

Get a job for a branch, part of an Amplify App.

Public Method GetWebhook(GetWebhookRequest)

Retrieves webhook info that corresponds to a webhookId.

Public Method GetWebhookAsync(GetWebhookRequest, CancellationToken)

Retrieves webhook info that corresponds to a webhookId.

Public Method ListApps(ListAppsRequest)

Lists existing Amplify Apps.

Public Method ListAppsAsync(ListAppsRequest, CancellationToken)

Lists existing Amplify Apps.

Public Method ListArtifacts(ListArtifactsRequest)

List artifacts with an app, a branch, a job and an artifact type.

Public Method ListArtifactsAsync(ListArtifactsRequest, CancellationToken)

List artifacts with an app, a branch, a job and an artifact type.

Public Method ListBackendEnvironments(ListBackendEnvironmentsRequest)

Lists backend environments for an Amplify App.

Public Method ListBackendEnvironmentsAsync(ListBackendEnvironmentsRequest, CancellationToken)

Lists backend environments for an Amplify App.

Public Method ListBranches(ListBranchesRequest)

Lists branches for an Amplify App.

Public Method ListBranchesAsync(ListBranchesRequest, CancellationToken)

Lists branches for an Amplify App.

Public Method ListDomainAssociations(ListDomainAssociationsRequest)

List domains with an app

Public Method ListDomainAssociationsAsync(ListDomainAssociationsRequest, CancellationToken)

List domains with an app

Public Method ListJobs(ListJobsRequest)

List Jobs for a branch, part of an Amplify App.

Public Method ListJobsAsync(ListJobsRequest, CancellationToken)

List Jobs for a branch, part of an Amplify App.

Public Method ListTagsForResource(ListTagsForResourceRequest)

List tags for resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

List tags for resource.

Public Method ListWebhooks(ListWebhooksRequest)

List webhooks with an app.

Public Method ListWebhooksAsync(ListWebhooksRequest, CancellationToken)

List webhooks with an app.

Public Method StartDeployment(StartDeploymentRequest)

Start a deployment for manual deploy apps. (Apps are not connected to repository)

Public Method StartDeploymentAsync(StartDeploymentRequest, CancellationToken)

Start a deployment for manual deploy apps. (Apps are not connected to repository)

Public Method StartJob(StartJobRequest)

Starts a new job for a branch, part of an Amplify App.

Public Method StartJobAsync(StartJobRequest, CancellationToken)

Starts a new job for a branch, part of an Amplify App.

Public Method StopJob(StopJobRequest)

Stop a job that is in progress, for an Amplify branch, part of Amplify App.

Public Method StopJobAsync(StopJobRequest, CancellationToken)

Stop a job that is in progress, for an Amplify branch, part of Amplify App.

Public Method TagResource(TagResourceRequest)

Tag resource with tag key and value.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Tag resource with tag key and value.

Public Method UntagResource(UntagResourceRequest)

Untag resource with resourceArn.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Untag resource with resourceArn.

Public Method UpdateApp(UpdateAppRequest)

Updates an existing Amplify App.

Public Method UpdateAppAsync(UpdateAppRequest, CancellationToken)

Updates an existing Amplify App.

Public Method UpdateBranch(UpdateBranchRequest)

Updates a branch for an Amplify App.

Public Method UpdateBranchAsync(UpdateBranchRequest, CancellationToken)

Updates a branch for an Amplify App.

Public Method UpdateDomainAssociation(UpdateDomainAssociationRequest)

Create a new DomainAssociation on an App

Public Method UpdateDomainAssociationAsync(UpdateDomainAssociationRequest, CancellationToken)

Create a new DomainAssociation on an App

Public Method UpdateWebhook(UpdateWebhookRequest)

Update a webhook.

Public Method UpdateWebhookAsync(UpdateWebhookRequest, CancellationToken)

Update a webhook.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms