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.

Classes

NameDescription
Class AmplifyPaginatorFactory

Paginators for the Amplify service

Class App

Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

Class Artifact

Describes an artifact.

Class AutoBranchCreationConfig

Describes the automated branch creation configuration.

Class Backend

Describes the backend properties associated with an Amplify Branch.

Class BackendEnvironment

Describes the backend environment for an Amplify app.

Class BadRequestException

A request contains unexpected data.

Class Branch

The branch for an Amplify app, which maps to a third-party repository branch.

Class Certificate

Describes the current SSL/TLS certificate that is in use for the domain. If you are using CreateDomainAssociation to create a new domain association, Certificate describes the new certificate that you are creating.

Class CertificateSettings

The type of SSL/TLS certificate to use for your custom domain. If a certificate type isn't specified, Amplify uses the default AMPLIFY_MANAGED certificate.

Class CreateAppRequest

Container for the parameters to the CreateApp operation. Creates a new Amplify app.

Class CreateAppResponse

This is the response object from the CreateApp operation.

Class CreateBackendEnvironmentRequest

Container for the parameters to the CreateBackendEnvironment operation. 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.

Class CreateBackendEnvironmentResponse

The result structure for the create backend environment request.

Class CreateBranchRequest

Container for the parameters to the CreateBranch operation. Creates a new branch for an Amplify app.

Class CreateBranchResponse

The result structure for create branch request.

Class CreateDeploymentRequest

Container for the parameters to the CreateDeployment operation. 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.

Class CreateDeploymentResponse

The result structure for the create a new deployment request.

Class CreateDomainAssociationRequest

Container for the parameters to the CreateDomainAssociation operation. Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app

Class CreateDomainAssociationResponse

The result structure for the create domain association request.

Class CreateWebhookRequest

Container for the parameters to the CreateWebhook operation. Creates a new webhook on an Amplify app.

Class CreateWebhookResponse

The result structure for the create webhook request.

Class CustomRule

Describes a custom rewrite or redirect rule.

Class DeleteAppRequest

Container for the parameters to the DeleteApp operation. Deletes an existing Amplify app specified by an app ID.

Class DeleteAppResponse

The result structure for the delete app request.

Class DeleteBackendEnvironmentRequest

Container for the parameters to the DeleteBackendEnvironment operation. 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.

Class DeleteBackendEnvironmentResponse

The result structure of the delete backend environment result.

Class DeleteBranchRequest

Container for the parameters to the DeleteBranch operation. Deletes a branch for an Amplify app.

Class DeleteBranchResponse

The result structure for the delete branch request.

Class DeleteDomainAssociationRequest

Container for the parameters to the DeleteDomainAssociation operation. Deletes a domain association for an Amplify app.

Class DeleteDomainAssociationResponse

This is the response object from the DeleteDomainAssociation operation.

Class DeleteJobRequest

Container for the parameters to the DeleteJob operation. Deletes a job for a branch of an Amplify app.

Class DeleteJobResponse

The result structure for the delete job request.

Class DeleteWebhookRequest

Container for the parameters to the DeleteWebhook operation. Deletes a webhook.

Class DeleteWebhookResponse

The result structure for the delete webhook request.

Class DependentServiceFailureException

An operation failed because a dependent service threw an exception.

Class DomainAssociation

Describes the association between a custom domain and an Amplify app.

Class GenerateAccessLogsRequest

Container for the parameters to the GenerateAccessLogs operation. Returns the website access logs for a specific time range using a presigned URL.

Class GenerateAccessLogsResponse

The result structure for the generate access logs request.

Class GetAppRequest

Container for the parameters to the GetApp operation. Returns an existing Amplify app specified by an app ID.

Class GetAppResponse

This is the response object from the GetApp operation.

Class GetArtifactUrlRequest

Container for the parameters to the GetArtifactUrl operation. Returns the artifact info that corresponds to an artifact id.

Class GetArtifactUrlResponse

Returns the result structure for the get artifact request.

Class GetBackendEnvironmentRequest

Container for the parameters to the GetBackendEnvironment operation. 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.

Class GetBackendEnvironmentResponse

The result structure for the get backend environment result.

Class GetBranchRequest

Container for the parameters to the GetBranch operation. Returns a branch for an Amplify app.

Class GetBranchResponse

This is the response object from the GetBranch operation.

Class GetDomainAssociationRequest

Container for the parameters to the GetDomainAssociation operation. Returns the domain information for an Amplify app.

Class GetDomainAssociationResponse

The result structure for the get domain association request.

Class GetJobRequest

Container for the parameters to the GetJob operation. Returns a job for a branch of an Amplify app.

Class GetJobResponse

This is the response object from the GetJob operation.

Class GetWebhookRequest

Container for the parameters to the GetWebhook operation. Returns the webhook information that corresponds to a specified webhook ID.

Class GetWebhookResponse

The result structure for the get webhook request.

Class InternalFailureException

The service failed to perform an operation due to an internal issue.

Class Job

Describes an execution job for an Amplify app.

Class JobSummary

Describes the summary for an execution job for an Amplify app.

Class LimitExceededException

A resource could not be created because service quotas were exceeded.

Class ListAppsRequest

Container for the parameters to the ListApps operation. Returns a list of the existing Amplify apps.

Class ListAppsResponse

The result structure for an Amplify app list request.

Class ListArtifactsRequest

Container for the parameters to the ListArtifacts operation. Returns a list of artifacts for a specified app, branch, and job.

Class ListArtifactsResponse

The result structure for the list artifacts request.

Class ListBackendEnvironmentsRequest

Container for the parameters to the ListBackendEnvironments operation. 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.

Class ListBackendEnvironmentsResponse

The result structure for the list backend environments result.

Class ListBranchesRequest

Container for the parameters to the ListBranches operation. Lists the branches of an Amplify app.

Class ListBranchesResponse

The result structure for the list branches request.

Class ListDomainAssociationsRequest

Container for the parameters to the ListDomainAssociations operation. Returns the domain associations for an Amplify app.

Class ListDomainAssociationsResponse

The result structure for the list domain association request.

Class ListJobsRequest

Container for the parameters to the ListJobs operation. Lists the jobs for a branch of an Amplify app.

Class ListJobsResponse

The maximum number of records to list in a single response.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Returns a list of tags for a specified Amazon Resource Name (ARN).

Class ListTagsForResourceResponse

The response for the list tags for resource request.

Class ListWebhooksRequest

Container for the parameters to the ListWebhooks operation. Returns a list of webhooks for an Amplify app.

Class ListWebhooksResponse

The result structure for the list webhooks request.

Class NotFoundException

An entity was not found during an operation.

Class ProductionBranch

Describes the information about a production branch for an Amplify app.

Class ResourceNotFoundException

An operation failed due to a non-existent resource.

Class StartDeploymentRequest

Container for the parameters to the StartDeployment operation. Starts a deployment for a manually deployed 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.

Class StartDeploymentResponse

The result structure for the start a deployment request.

Class StartJobRequest

Container for the parameters to the StartJob operation. Starts a new job for a branch of an Amplify app.

Class StartJobResponse

The result structure for the run job request.

Class Step

Describes an execution step, for an execution job, for an Amplify app.

Class StopJobRequest

Container for the parameters to the StopJob operation. Stops a job that is in progress for a branch of an Amplify app.

Class StopJobResponse

The result structure for the stop job request.

Class SubDomain

The subdomain for the domain association.

Class SubDomainSetting

Describes the settings for the subdomain.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Tags the resource with a tag key and value.

Class TagResourceResponse

The response for the tag resource request.

Class UnauthorizedException

An operation failed due to a lack of access.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Untags a resource with a specified Amazon Resource Name (ARN).

Class UntagResourceResponse

The response for the untag resource request.

Class UpdateAppRequest

Container for the parameters to the UpdateApp operation. Updates an existing Amplify app.

Class UpdateAppResponse

The result structure for an Amplify app update request.

Class UpdateBranchRequest

Container for the parameters to the UpdateBranch operation. Updates a branch for an Amplify app.

Class UpdateBranchResponse

The result structure for the update branch request.

Class UpdateDomainAssociationRequest

Container for the parameters to the UpdateDomainAssociation operation. Creates a new domain association for an Amplify app.

Class UpdateDomainAssociationResponse

The result structure for the update domain association request.

Class UpdateWebhookRequest

Container for the parameters to the UpdateWebhook operation. Updates a webhook.

Class UpdateWebhookResponse

The result structure for the update webhook request.

Class Webhook

Describes a webhook that connects repository events to an Amplify app.

Interfaces

NameDescription
Interface IAmplifyPaginatorFactory

Paginators for the Amplify service

Interface IListAppsPaginator

Paginator for the ListApps operation

Interface IListBranchesPaginator

Paginator for the ListBranches operation

Interface IListDomainAssociationsPaginator

Paginator for the ListDomainAssociations operation

Interface IListJobsPaginator

Paginator for the ListJobs operation