amplify/aws.sdk.kotlin.services.amplify/AmplifyClient

AmplifyClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<AmplifyClient.Config, AmplifyClient.Config.Builder, AmplifyClient>

Companion

object Companion : AbstractAwsSdkClientFactory<AmplifyClient.Config, AmplifyClient.Config.Builder, AmplifyClient, AmplifyClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: AmplifyClient.Config

AmplifyClient's configuration

Functions

createApp

abstract suspend fun createApp(input: CreateAppRequest): CreateAppResponse

Creates a new Amplify app.

createBackendEnvironment

abstract suspend fun createBackendEnvironment(input: CreateBackendEnvironmentRequest): CreateBackendEnvironmentResponse

Creates a new backend environment for an Amplify app.

createBranch

abstract suspend fun createBranch(input: CreateBranchRequest): CreateBranchResponse

Creates a new branch for an Amplify app.

createDeployment

abstract suspend fun createDeployment(input: CreateDeploymentRequest): CreateDeploymentResponse

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a Git repository.

createDomainAssociation

abstract suspend fun createDomainAssociation(input: CreateDomainAssociationRequest): CreateDomainAssociationResponse

Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app

createWebhook

abstract suspend fun createWebhook(input: CreateWebhookRequest): CreateWebhookResponse

Creates a new webhook on an Amplify app.

deleteApp

abstract suspend fun deleteApp(input: DeleteAppRequest): DeleteAppResponse

Deletes an existing Amplify app specified by an app ID.

deleteBackendEnvironment

abstract suspend fun deleteBackendEnvironment(input: DeleteBackendEnvironmentRequest): DeleteBackendEnvironmentResponse

Deletes a backend environment for an Amplify app.

deleteBranch

abstract suspend fun deleteBranch(input: DeleteBranchRequest): DeleteBranchResponse

Deletes a branch for an Amplify app.

deleteDomainAssociation

abstract suspend fun deleteDomainAssociation(input: DeleteDomainAssociationRequest): DeleteDomainAssociationResponse

Deletes a domain association for an Amplify app.

deleteJob

abstract suspend fun deleteJob(input: DeleteJobRequest): DeleteJobResponse

Deletes a job for a branch of an Amplify app.

deleteWebhook

abstract suspend fun deleteWebhook(input: DeleteWebhookRequest): DeleteWebhookResponse

Deletes a webhook.

generateAccessLogs

abstract suspend fun generateAccessLogs(input: GenerateAccessLogsRequest): GenerateAccessLogsResponse

Returns the website access logs for a specific time range using a presigned URL.

getApp

abstract suspend fun getApp(input: GetAppRequest): GetAppResponse

Returns an existing Amplify app specified by an app ID.

getArtifactUrl

abstract suspend fun getArtifactUrl(input: GetArtifactUrlRequest): GetArtifactUrlResponse

Returns the artifact info that corresponds to an artifact id.

getBackendEnvironment

abstract suspend fun getBackendEnvironment(input: GetBackendEnvironmentRequest): GetBackendEnvironmentResponse

Returns a backend environment for an Amplify app.

getBranch

abstract suspend fun getBranch(input: GetBranchRequest): GetBranchResponse

Returns a branch for an Amplify app.

getDomainAssociation

abstract suspend fun getDomainAssociation(input: GetDomainAssociationRequest): GetDomainAssociationResponse

Returns the domain information for an Amplify app.

getJob

abstract suspend fun getJob(input: GetJobRequest): GetJobResponse

Returns a job for a branch of an Amplify app.

getWebhook

abstract suspend fun getWebhook(input: GetWebhookRequest): GetWebhookResponse

Returns the webhook information that corresponds to a specified webhook ID.

listApps

abstract suspend fun listApps(input: ListAppsRequest = ListAppsRequest { }): ListAppsResponse

Returns a list of the existing Amplify apps.

listArtifacts

abstract suspend fun listArtifacts(input: ListArtifactsRequest): ListArtifactsResponse

Returns a list of end-to-end testing artifacts for a specified app, branch, and job.

listBackendEnvironments

abstract suspend fun listBackendEnvironments(input: ListBackendEnvironmentsRequest): ListBackendEnvironmentsResponse

Lists the backend environments for an Amplify app.

listBranches

abstract suspend fun listBranches(input: ListBranchesRequest): ListBranchesResponse

Lists the branches of an Amplify app.

listDomainAssociations

abstract suspend fun listDomainAssociations(input: ListDomainAssociationsRequest): ListDomainAssociationsResponse

Returns the domain associations for an Amplify app.

listJobs

abstract suspend fun listJobs(input: ListJobsRequest): ListJobsResponse

Lists the jobs for a branch of an Amplify app.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Returns a list of tags for a specified Amazon Resource Name (ARN).

listWebhooks

abstract suspend fun listWebhooks(input: ListWebhooksRequest): ListWebhooksResponse

Returns a list of webhooks for an Amplify app.

startDeployment

abstract suspend fun startDeployment(input: StartDeploymentRequest): StartDeploymentResponse

Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git repository.

startJob

abstract suspend fun startJob(input: StartJobRequest): StartJobResponse

Starts a new job for a branch of an Amplify app.

stopJob

abstract suspend fun stopJob(input: StopJobRequest): StopJobResponse

Stops a job that is in progress for a branch of an Amplify app.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Tags the resource with a tag key and value.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Untags a resource with a specified Amazon Resource Name (ARN).

updateApp

abstract suspend fun updateApp(input: UpdateAppRequest): UpdateAppResponse

Updates an existing Amplify app.

updateBranch

abstract suspend fun updateBranch(input: UpdateBranchRequest): UpdateBranchResponse

Updates a branch for an Amplify app.

updateDomainAssociation

abstract suspend fun updateDomainAssociation(input: UpdateDomainAssociationRequest): UpdateDomainAssociationResponse

Creates a new domain association for an Amplify app.

updateWebhook

abstract suspend fun updateWebhook(input: UpdateWebhookRequest): UpdateWebhookResponse

Updates a webhook.

Inherited functions

expect abstract fun close()

createApp

inline suspend fun AmplifyClient.createApp(crossinline block: CreateAppRequest.Builder.() -> Unit): CreateAppResponse

Creates a new Amplify app.

createBackendEnvironment

inline suspend fun AmplifyClient.createBackendEnvironment(crossinline block: CreateBackendEnvironmentRequest.Builder.() -> Unit): CreateBackendEnvironmentResponse

Creates a new backend environment for an Amplify app.

createBranch

inline suspend fun AmplifyClient.createBranch(crossinline block: CreateBranchRequest.Builder.() -> Unit): CreateBranchResponse

Creates a new branch for an Amplify app.

createDeployment

inline suspend fun AmplifyClient.createDeployment(crossinline block: CreateDeploymentRequest.Builder.() -> Unit): CreateDeploymentResponse

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a Git repository.

createDomainAssociation

inline suspend fun AmplifyClient.createDomainAssociation(crossinline block: CreateDomainAssociationRequest.Builder.() -> Unit): CreateDomainAssociationResponse

Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app

createWebhook

inline suspend fun AmplifyClient.createWebhook(crossinline block: CreateWebhookRequest.Builder.() -> Unit): CreateWebhookResponse

Creates a new webhook on an Amplify app.

deleteApp

inline suspend fun AmplifyClient.deleteApp(crossinline block: DeleteAppRequest.Builder.() -> Unit): DeleteAppResponse

Deletes an existing Amplify app specified by an app ID.

deleteBackendEnvironment

inline suspend fun AmplifyClient.deleteBackendEnvironment(crossinline block: DeleteBackendEnvironmentRequest.Builder.() -> Unit): DeleteBackendEnvironmentResponse

Deletes a backend environment for an Amplify app.

deleteBranch

inline suspend fun AmplifyClient.deleteBranch(crossinline block: DeleteBranchRequest.Builder.() -> Unit): DeleteBranchResponse

Deletes a branch for an Amplify app.

deleteDomainAssociation

inline suspend fun AmplifyClient.deleteDomainAssociation(crossinline block: DeleteDomainAssociationRequest.Builder.() -> Unit): DeleteDomainAssociationResponse

Deletes a domain association for an Amplify app.

deleteJob

inline suspend fun AmplifyClient.deleteJob(crossinline block: DeleteJobRequest.Builder.() -> Unit): DeleteJobResponse

Deletes a job for a branch of an Amplify app.

deleteWebhook

inline suspend fun AmplifyClient.deleteWebhook(crossinline block: DeleteWebhookRequest.Builder.() -> Unit): DeleteWebhookResponse

Deletes a webhook.

generateAccessLogs

inline suspend fun AmplifyClient.generateAccessLogs(crossinline block: GenerateAccessLogsRequest.Builder.() -> Unit): GenerateAccessLogsResponse

Returns the website access logs for a specific time range using a presigned URL.

getApp

inline suspend fun AmplifyClient.getApp(crossinline block: GetAppRequest.Builder.() -> Unit): GetAppResponse

Returns an existing Amplify app specified by an app ID.

getArtifactUrl

inline suspend fun AmplifyClient.getArtifactUrl(crossinline block: GetArtifactUrlRequest.Builder.() -> Unit): GetArtifactUrlResponse

Returns the artifact info that corresponds to an artifact id.

getBackendEnvironment

inline suspend fun AmplifyClient.getBackendEnvironment(crossinline block: GetBackendEnvironmentRequest.Builder.() -> Unit): GetBackendEnvironmentResponse

Returns a backend environment for an Amplify app.

getBranch

inline suspend fun AmplifyClient.getBranch(crossinline block: GetBranchRequest.Builder.() -> Unit): GetBranchResponse

Returns a branch for an Amplify app.

getDomainAssociation

inline suspend fun AmplifyClient.getDomainAssociation(crossinline block: GetDomainAssociationRequest.Builder.() -> Unit): GetDomainAssociationResponse

Returns the domain information for an Amplify app.

getJob

inline suspend fun AmplifyClient.getJob(crossinline block: GetJobRequest.Builder.() -> Unit): GetJobResponse

Returns a job for a branch of an Amplify app.

getWebhook

inline suspend fun AmplifyClient.getWebhook(crossinline block: GetWebhookRequest.Builder.() -> Unit): GetWebhookResponse

Returns the webhook information that corresponds to a specified webhook ID.

listApps

inline suspend fun AmplifyClient.listApps(crossinline block: ListAppsRequest.Builder.() -> Unit): ListAppsResponse

Returns a list of the existing Amplify apps.

listAppsPaginated

fun AmplifyClient.listAppsPaginated(initialRequest: ListAppsRequest = ListAppsRequest { }): Flow<ListAppsResponse>

fun AmplifyClient.listAppsPaginated(block: ListAppsRequest.Builder.() -> Unit): Flow<ListAppsResponse>

Paginate over ListAppsResponse results.

listArtifacts

inline suspend fun AmplifyClient.listArtifacts(crossinline block: ListArtifactsRequest.Builder.() -> Unit): ListArtifactsResponse

Returns a list of end-to-end testing artifacts for a specified app, branch, and job.

listBackendEnvironments

inline suspend fun AmplifyClient.listBackendEnvironments(crossinline block: ListBackendEnvironmentsRequest.Builder.() -> Unit): ListBackendEnvironmentsResponse

Lists the backend environments for an Amplify app.

listBranches

inline suspend fun AmplifyClient.listBranches(crossinline block: ListBranchesRequest.Builder.() -> Unit): ListBranchesResponse

Lists the branches of an Amplify app.

listBranchesPaginated

fun AmplifyClient.listBranchesPaginated(initialRequest: ListBranchesRequest): Flow<ListBranchesResponse>

fun AmplifyClient.listBranchesPaginated(block: ListBranchesRequest.Builder.() -> Unit): Flow<ListBranchesResponse>

Paginate over ListBranchesResponse results.

listDomainAssociations

inline suspend fun AmplifyClient.listDomainAssociations(crossinline block: ListDomainAssociationsRequest.Builder.() -> Unit): ListDomainAssociationsResponse

Returns the domain associations for an Amplify app.

listDomainAssociationsPaginated

fun AmplifyClient.listDomainAssociationsPaginated(initialRequest: ListDomainAssociationsRequest): Flow<ListDomainAssociationsResponse>

fun AmplifyClient.listDomainAssociationsPaginated(block: ListDomainAssociationsRequest.Builder.() -> Unit): Flow<ListDomainAssociationsResponse>

Paginate over ListDomainAssociationsResponse results.

listJobs

inline suspend fun AmplifyClient.listJobs(crossinline block: ListJobsRequest.Builder.() -> Unit): ListJobsResponse

Lists the jobs for a branch of an Amplify app.

listJobsPaginated

fun AmplifyClient.listJobsPaginated(initialRequest: ListJobsRequest): Flow<ListJobsResponse>

fun AmplifyClient.listJobsPaginated(block: ListJobsRequest.Builder.() -> Unit): Flow<ListJobsResponse>

Paginate over ListJobsResponse results.

listTagsForResource

inline suspend fun AmplifyClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns a list of tags for a specified Amazon Resource Name (ARN).

listWebhooks

inline suspend fun AmplifyClient.listWebhooks(crossinline block: ListWebhooksRequest.Builder.() -> Unit): ListWebhooksResponse

Returns a list of webhooks for an Amplify app.

startDeployment

inline suspend fun AmplifyClient.startDeployment(crossinline block: StartDeploymentRequest.Builder.() -> Unit): StartDeploymentResponse

Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git repository.

startJob

inline suspend fun AmplifyClient.startJob(crossinline block: StartJobRequest.Builder.() -> Unit): StartJobResponse

Starts a new job for a branch of an Amplify app.

stopJob

inline suspend fun AmplifyClient.stopJob(crossinline block: StopJobRequest.Builder.() -> Unit): StopJobResponse

Stops a job that is in progress for a branch of an Amplify app.

tagResource

inline suspend fun AmplifyClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Tags the resource with a tag key and value.

untagResource

inline suspend fun AmplifyClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Untags a resource with a specified Amazon Resource Name (ARN).

updateApp

inline suspend fun AmplifyClient.updateApp(crossinline block: UpdateAppRequest.Builder.() -> Unit): UpdateAppResponse

Updates an existing Amplify app.

updateBranch

inline suspend fun AmplifyClient.updateBranch(crossinline block: UpdateBranchRequest.Builder.() -> Unit): UpdateBranchResponse

Updates a branch for an Amplify app.

updateDomainAssociation

inline suspend fun AmplifyClient.updateDomainAssociation(crossinline block: UpdateDomainAssociationRequest.Builder.() -> Unit): UpdateDomainAssociationResponse

Creates a new domain association for an Amplify app.

updateWebhook

inline suspend fun AmplifyClient.updateWebhook(crossinline block: UpdateWebhookRequest.Builder.() -> Unit): UpdateWebhookResponse

Updates a webhook.

withConfig

fun AmplifyClient.withConfig(block: AmplifyClient.Config.Builder.() -> Unit): AmplifyClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.