View on GitHub
Amplify Structure Reference
Amplify
public struct AmplifyClient object for interacting with AWS Amplify service.
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.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the Amplify client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Creates a new Amplify app.
Declaration
Swift
public func createApp(_ input: CreateAppRequest) -> EventLoopFuture<CreateAppResult> -
Creates a new backend environment for an Amplify app.
Declaration
Swift
public func createBackendEnvironment(_ input: CreateBackendEnvironmentRequest) -> EventLoopFuture<CreateBackendEnvironmentResult> -
Creates a new branch for an Amplify app.
Declaration
Swift
public func createBranch(_ input: CreateBranchRequest) -> EventLoopFuture<CreateBranchResult> -
Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
Declaration
Swift
public func createDeployment(_ input: CreateDeploymentRequest) -> EventLoopFuture<CreateDeploymentResult> -
Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
Declaration
Swift
public func createDomainAssociation(_ input: CreateDomainAssociationRequest) -> EventLoopFuture<CreateDomainAssociationResult> -
Creates a new webhook on an Amplify app.
Declaration
Swift
public func createWebhook(_ input: CreateWebhookRequest) -> EventLoopFuture<CreateWebhookResult> -
Deletes an existing Amplify app specified by an app ID.
Declaration
Swift
public func deleteApp(_ input: DeleteAppRequest) -> EventLoopFuture<DeleteAppResult> -
Deletes a backend environment for an Amplify app.
Declaration
Swift
public func deleteBackendEnvironment(_ input: DeleteBackendEnvironmentRequest) -> EventLoopFuture<DeleteBackendEnvironmentResult> -
Deletes a branch for an Amplify app.
Declaration
Swift
public func deleteBranch(_ input: DeleteBranchRequest) -> EventLoopFuture<DeleteBranchResult> -
Deletes a domain association for an Amplify app.
Declaration
Swift
public func deleteDomainAssociation(_ input: DeleteDomainAssociationRequest) -> EventLoopFuture<DeleteDomainAssociationResult> -
Deletes a job for a branch of an Amplify app.
Declaration
Swift
public func deleteJob(_ input: DeleteJobRequest) -> EventLoopFuture<DeleteJobResult> -
Deletes a webhook.
Declaration
Swift
public func deleteWebhook(_ input: DeleteWebhookRequest) -> EventLoopFuture<DeleteWebhookResult> -
Returns the website access logs for a specific time range using a presigned URL.
Declaration
Swift
public func generateAccessLogs(_ input: GenerateAccessLogsRequest) -> EventLoopFuture<GenerateAccessLogsResult> -
Returns an existing Amplify app by appID.
Declaration
Swift
public func getApp(_ input: GetAppRequest) -> EventLoopFuture<GetAppResult> -
Returns the artifact info that corresponds to an artifact id.
Declaration
Swift
public func getArtifactUrl(_ input: GetArtifactUrlRequest) -> EventLoopFuture<GetArtifactUrlResult> -
Returns a backend environment for an Amplify app.
Declaration
Swift
public func getBackendEnvironment(_ input: GetBackendEnvironmentRequest) -> EventLoopFuture<GetBackendEnvironmentResult> -
Returns a branch for an Amplify app.
Declaration
Swift
public func getBranch(_ input: GetBranchRequest) -> EventLoopFuture<GetBranchResult> -
Returns the domain information for an Amplify app.
Declaration
Swift
public func getDomainAssociation(_ input: GetDomainAssociationRequest) -> EventLoopFuture<GetDomainAssociationResult> -
Returns a job for a branch of an Amplify app.
Declaration
Swift
public func getJob(_ input: GetJobRequest) -> EventLoopFuture<GetJobResult> -
Returns the webhook information that corresponds to a specified webhook ID.
Declaration
Swift
public func getWebhook(_ input: GetWebhookRequest) -> EventLoopFuture<GetWebhookResult> -
Returns a list of the existing Amplify apps.
Declaration
Swift
public func listApps(_ input: ListAppsRequest) -> EventLoopFuture<ListAppsResult> -
Returns a list of artifacts for a specified app, branch, and job.
Declaration
Swift
public func listArtifacts(_ input: ListArtifactsRequest) -> EventLoopFuture<ListArtifactsResult> -
Lists the backend environments for an Amplify app.
Declaration
Swift
public func listBackendEnvironments(_ input: ListBackendEnvironmentsRequest) -> EventLoopFuture<ListBackendEnvironmentsResult> -
Lists the branches of an Amplify app.
Declaration
Swift
public func listBranches(_ input: ListBranchesRequest) -> EventLoopFuture<ListBranchesResult> -
Returns the domain associations for an Amplify app.
Declaration
Swift
public func listDomainAssociations(_ input: ListDomainAssociationsRequest) -> EventLoopFuture<ListDomainAssociationsResult> -
Lists the jobs for a branch of an Amplify app.
Declaration
Swift
public func listJobs(_ input: ListJobsRequest) -> EventLoopFuture<ListJobsResult> -
Returns a list of tags for a specified Amazon Resource Name (ARN).
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse> -
Returns a list of webhooks for an Amplify app.
Declaration
Swift
public func listWebhooks(_ input: ListWebhooksRequest) -> EventLoopFuture<ListWebhooksResult> -
Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
Declaration
Swift
public func startDeployment(_ input: StartDeploymentRequest) -> EventLoopFuture<StartDeploymentResult> -
Starts a new job for a branch of an Amplify app.
Declaration
Swift
public func startJob(_ input: StartJobRequest) -> EventLoopFuture<StartJobResult> -
Stops a job that is in progress for a branch of an Amplify app.
Declaration
Swift
public func stopJob(_ input: StopJobRequest) -> EventLoopFuture<StopJobResult> -
Tags the resource with a tag key and value.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse> -
Untags a resource with a specified Amazon Resource Name (ARN).
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse> -
Updates an existing Amplify app.
Declaration
Swift
public func updateApp(_ input: UpdateAppRequest) -> EventLoopFuture<UpdateAppResult> -
Updates a branch for an Amplify app.
Declaration
Swift
public func updateBranch(_ input: UpdateBranchRequest) -> EventLoopFuture<UpdateBranchResult> -
Creates a new domain association for an Amplify app.
Declaration
Swift
public func updateDomainAssociation(_ input: UpdateDomainAssociationRequest) -> EventLoopFuture<UpdateDomainAssociationResult> -
Updates a webhook.
Declaration
Swift
public func updateWebhook(_ input: UpdateWebhookRequest) -> EventLoopFuture<UpdateWebhookResult>
-
Undocumented
See moreDeclaration
Swift
public enum DomainStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum JobStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum JobType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum Platform : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum Stage : String, CustomStringConvertible, Codable