Expand description
Amplify enables developers to develop and deploy cloud-powered mobile and web apps. The Amplify Console provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Console 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.
If you’re using the service, you’re probably looking for AmplifyClient and Amplify.
Structs§
- Amplify
Client - A client for the Amplify API.
- App
Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
- Artifact
Describes an artifact.
- Auto
Branch Creation Config Describes the automated branch creation configuration.
- Backend
Environment Describes the backend environment for an Amplify app.
- Branch
The branch for an Amplify app, which maps to a third-party repository branch.
- Create
AppRequest The request structure used to create apps in Amplify.
- Create
AppResult - Create
Backend Environment Request The request structure for the backend environment create request.
- Create
Backend Environment Result The result structure for the create backend environment request.
- Create
Branch Request The request structure for the create branch request.
- Create
Branch Result The result structure for create branch request.
- Create
Deployment Request The request structure for the create a new deployment request.
- Create
Deployment Result The result structure for the create a new deployment request.
- Create
Domain Association Request The request structure for the create domain association request.
- Create
Domain Association Result The result structure for the create domain association request.
- Create
Webhook Request The request structure for the create webhook request.
- Create
Webhook Result The result structure for the create webhook request.
- Custom
Rule Describes a custom rewrite or redirect rule.
- Delete
AppRequest Describes the request structure for the delete app request.
- Delete
AppResult The result structure for the delete app request.
- Delete
Backend Environment Request The request structure for the delete backend environment request.
- Delete
Backend Environment Result The result structure of the delete backend environment result.
- Delete
Branch Request The request structure for the delete branch request.
- Delete
Branch Result The result structure for the delete branch request.
- Delete
Domain Association Request The request structure for the delete domain association request.
- Delete
Domain Association Result - Delete
JobRequest The request structure for the delete job request.
- Delete
JobResult The result structure for the delete job request.
- Delete
Webhook Request The request structure for the delete webhook request.
- Delete
Webhook Result The result structure for the delete webhook request.
- Domain
Association Describes a domain association that associates a custom domain with an Amplify app.
- Generate
Access Logs Request The request structure for the generate access logs request.
- Generate
Access Logs Result The result structure for the generate access logs request.
- GetApp
Request The request structure for the get app request.
- GetApp
Result - GetArtifact
UrlRequest Returns the request structure for the get artifact request.
- GetArtifact
UrlResult Returns the result structure for the get artifact request.
- GetBackend
Environment Request The request structure for the get backend environment request.
- GetBackend
Environment Result The result structure for the get backend environment result.
- GetBranch
Request The request structure for the get branch request.
- GetBranch
Result - GetDomain
Association Request The request structure for the get domain association request.
- GetDomain
Association Result The result structure for the get domain association request.
- GetJob
Request The request structure for the get job request.
- GetJob
Result - GetWebhook
Request The request structure for the get webhook request.
- GetWebhook
Result The result structure for the get webhook request.
- Job
Describes an execution job for an Amplify app.
- JobSummary
Describes the summary for an execution job for an Amplify app.
- List
Apps Request The request structure for the list apps request.
- List
Apps Result The result structure for an Amplify app list request.
- List
Artifacts Request Describes the request structure for the list artifacts request.
- List
Artifacts Result The result structure for the list artifacts request.
- List
Backend Environments Request The request structure for the list backend environments request.
- List
Backend Environments Result The result structure for the list backend environments result.
- List
Branches Request The request structure for the list branches request.
- List
Branches Result The result structure for the list branches request.
- List
Domain Associations Request The request structure for the list domain associations request.
- List
Domain Associations Result The result structure for the list domain association request.
- List
Jobs Request The request structure for the list jobs request.
- List
Jobs Result The maximum number of records to list in a single response.
- List
Tags ForResource Request The request structure to use to list tags for a resource.
- List
Tags ForResource Response The response for the list tags for resource request.
- List
Webhooks Request The request structure for the list webhooks request.
- List
Webhooks Result The result structure for the list webhooks request.
- Production
Branch Describes the information about a production branch for an Amplify app.
- Start
Deployment Request The request structure for the start a deployment request.
- Start
Deployment Result The result structure for the start a deployment request.
- Start
JobRequest The request structure for the start job request.
- Start
JobResult The result structure for the run job request.
- Step
Describes an execution step, for an execution job, for an Amplify app.
- Stop
JobRequest The request structure for the stop job request.
- Stop
JobResult The result structure for the stop job request.
- SubDomain
The subdomain for the domain association.
- SubDomain
Setting Describes the settings for the subdomain.
- TagResource
Request The request structure to tag a resource with a tag key and value.
- TagResource
Response The response for the tag resource request.
- Untag
Resource Request The request structure for the untag resource request.
- Untag
Resource Response The response for the untag resource request.
- Update
AppRequest The request structure for the update app request.
- Update
AppResult The result structure for an Amplify app update request.
- Update
Branch Request The request structure for the update branch request.
- Update
Branch Result The result structure for the update branch request.
- Update
Domain Association Request The request structure for the update domain association request.
- Update
Domain Association Result The result structure for the update domain association request.
- Update
Webhook Request The request structure for the update webhook request.
- Update
Webhook Result The result structure for the update webhook request.
- Webhook
Describes a webhook that connects repository events to an Amplify app.
Enums§
- Create
AppError - Errors returned by CreateApp
- Create
Backend Environment Error - Errors returned by CreateBackendEnvironment
- Create
Branch Error - Errors returned by CreateBranch
- Create
Deployment Error - Errors returned by CreateDeployment
- Create
Domain Association Error - Errors returned by CreateDomainAssociation
- Create
Webhook Error - Errors returned by CreateWebhook
- Delete
AppError - Errors returned by DeleteApp
- Delete
Backend Environment Error - Errors returned by DeleteBackendEnvironment
- Delete
Branch Error - Errors returned by DeleteBranch
- Delete
Domain Association Error - Errors returned by DeleteDomainAssociation
- Delete
JobError - Errors returned by DeleteJob
- Delete
Webhook Error - Errors returned by DeleteWebhook
- Generate
Access Logs Error - Errors returned by GenerateAccessLogs
- GetApp
Error - Errors returned by GetApp
- GetArtifact
UrlError - Errors returned by GetArtifactUrl
- GetBackend
Environment Error - Errors returned by GetBackendEnvironment
- GetBranch
Error - Errors returned by GetBranch
- GetDomain
Association Error - Errors returned by GetDomainAssociation
- GetJob
Error - Errors returned by GetJob
- GetWebhook
Error - Errors returned by GetWebhook
- List
Apps Error - Errors returned by ListApps
- List
Artifacts Error - Errors returned by ListArtifacts
- List
Backend Environments Error - Errors returned by ListBackendEnvironments
- List
Branches Error - Errors returned by ListBranches
- List
Domain Associations Error - Errors returned by ListDomainAssociations
- List
Jobs Error - Errors returned by ListJobs
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Webhooks Error - Errors returned by ListWebhooks
- Start
Deployment Error - Errors returned by StartDeployment
- Start
JobError - Errors returned by StartJob
- Stop
JobError - Errors returned by StopJob
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
AppError - Errors returned by UpdateApp
- Update
Branch Error - Errors returned by UpdateBranch
- Update
Domain Association Error - Errors returned by UpdateDomainAssociation
- Update
Webhook Error - Errors returned by UpdateWebhook
Traits§
- Amplify
- Trait representing the capabilities of the Amplify API. Amplify clients implement this trait.