amplifybackend/aws.sdk.kotlin.services.amplifybackend

Package-level declarations

Types

AmplifyBackendClient

interface AmplifyBackendClient : SdkClient

AWS Amplify Admin API

Properties

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

const val ServiceId: String

Functions

inline suspend fun AmplifyBackendClient.cloneBackend(crossinline block: CloneBackendRequest.Builder.() -> Unit): CloneBackendResponse

This operation clones an existing backend.

inline suspend fun AmplifyBackendClient.createBackend(crossinline block: CreateBackendRequest.Builder.() -> Unit): CreateBackendResponse

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

createBackendApi

inline suspend fun AmplifyBackendClient.createBackendApi(crossinline block: CreateBackendApiRequest.Builder.() -> Unit): CreateBackendApiResponse

Creates a new backend API resource.

createBackendAuth

inline suspend fun AmplifyBackendClient.createBackendAuth(crossinline block: CreateBackendAuthRequest.Builder.() -> Unit): CreateBackendAuthResponse

Creates a new backend authentication resource.

createBackendConfig

inline suspend fun AmplifyBackendClient.createBackendConfig(crossinline block: CreateBackendConfigRequest.Builder.() -> Unit): CreateBackendConfigResponse

Creates a config object for a backend.

createBackendStorage

inline suspend fun AmplifyBackendClient.createBackendStorage(crossinline block: CreateBackendStorageRequest.Builder.() -> Unit): CreateBackendStorageResponse

Creates a backend storage resource.

inline suspend fun AmplifyBackendClient.createToken(crossinline block: CreateTokenRequest.Builder.() -> Unit): CreateTokenResponse

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

inline suspend fun AmplifyBackendClient.deleteBackend(crossinline block: DeleteBackendRequest.Builder.() -> Unit): DeleteBackendResponse

Removes an existing environment from your Amplify project.

deleteBackendApi

inline suspend fun AmplifyBackendClient.deleteBackendApi(crossinline block: DeleteBackendApiRequest.Builder.() -> Unit): DeleteBackendApiResponse

Deletes an existing backend API resource.

deleteBackendAuth

inline suspend fun AmplifyBackendClient.deleteBackendAuth(crossinline block: DeleteBackendAuthRequest.Builder.() -> Unit): DeleteBackendAuthResponse

Deletes an existing backend authentication resource.

deleteBackendStorage

inline suspend fun AmplifyBackendClient.deleteBackendStorage(crossinline block: DeleteBackendStorageRequest.Builder.() -> Unit): DeleteBackendStorageResponse

Removes the specified backend storage resource.

inline suspend fun AmplifyBackendClient.deleteToken(crossinline block: DeleteTokenRequest.Builder.() -> Unit): DeleteTokenResponse

Deletes the challenge token based on the given appId and sessionId.

generateBackendApiModels

inline suspend fun AmplifyBackendClient.generateBackendApiModels(crossinline block: GenerateBackendApiModelsRequest.Builder.() -> Unit): GenerateBackendApiModelsResponse

Generates a model schema for an existing backend API resource.

inline suspend fun AmplifyBackendClient.getBackend(crossinline block: GetBackendRequest.Builder.() -> Unit): GetBackendResponse

Provides project-level details for your Amplify UI project.

inline suspend fun AmplifyBackendClient.getBackendApi(crossinline block: GetBackendApiRequest.Builder.() -> Unit): GetBackendApiResponse

Gets the details for a backend API.

getBackendApiModels

inline suspend fun AmplifyBackendClient.getBackendApiModels(crossinline block: GetBackendApiModelsRequest.Builder.() -> Unit): GetBackendApiModelsResponse

Gets a model introspection schema for an existing backend API resource.

inline suspend fun AmplifyBackendClient.getBackendAuth(crossinline block: GetBackendAuthRequest.Builder.() -> Unit): GetBackendAuthResponse

Gets a backend auth details.

inline suspend fun AmplifyBackendClient.getBackendJob(crossinline block: GetBackendJobRequest.Builder.() -> Unit): GetBackendJobResponse

Returns information about a specific job.

getBackendStorage

inline suspend fun AmplifyBackendClient.getBackendStorage(crossinline block: GetBackendStorageRequest.Builder.() -> Unit): GetBackendStorageResponse

Gets details for a backend storage resource.

inline suspend fun AmplifyBackendClient.getToken(crossinline block: GetTokenRequest.Builder.() -> Unit): GetTokenResponse

Gets the challenge token based on the given appId and sessionId.

importBackendAuth

inline suspend fun AmplifyBackendClient.importBackendAuth(crossinline block: ImportBackendAuthRequest.Builder.() -> Unit): ImportBackendAuthResponse

Imports an existing backend authentication resource.

importBackendStorage

inline suspend fun AmplifyBackendClient.importBackendStorage(crossinline block: ImportBackendStorageRequest.Builder.() -> Unit): ImportBackendStorageResponse

Imports an existing backend storage resource.

listBackendJobs

inline suspend fun AmplifyBackendClient.listBackendJobs(crossinline block: ListBackendJobsRequest.Builder.() -> Unit): ListBackendJobsResponse

Lists the jobs for the backend of an Amplify app.

inline suspend fun AmplifyBackendClient.listS3Buckets(crossinline block: ListS3BucketsRequest.Builder.() -> Unit): ListS3BucketsResponse

The list of S3 buckets in your account.

removeAllBackends

inline suspend fun AmplifyBackendClient.removeAllBackends(crossinline block: RemoveAllBackendsRequest.Builder.() -> Unit): RemoveAllBackendsResponse

Removes all backend environments from your Amplify project.

removeBackendConfig

inline suspend fun AmplifyBackendClient.removeBackendConfig(crossinline block: RemoveBackendConfigRequest.Builder.() -> Unit): RemoveBackendConfigResponse

Removes the AWS resources required to access the Amplify Admin UI.

updateBackendApi

inline suspend fun AmplifyBackendClient.updateBackendApi(crossinline block: UpdateBackendApiRequest.Builder.() -> Unit): UpdateBackendApiResponse

Updates an existing backend API resource.

updateBackendAuth

inline suspend fun AmplifyBackendClient.updateBackendAuth(crossinline block: UpdateBackendAuthRequest.Builder.() -> Unit): UpdateBackendAuthResponse

Updates an existing backend authentication resource.

updateBackendConfig

inline suspend fun AmplifyBackendClient.updateBackendConfig(crossinline block: UpdateBackendConfigRequest.Builder.() -> Unit): UpdateBackendConfigResponse

Updates the AWS resources required to access the Amplify Admin UI.

updateBackendJob

inline suspend fun AmplifyBackendClient.updateBackendJob(crossinline block: UpdateBackendJobRequest.Builder.() -> Unit): UpdateBackendJobResponse

Updates a specific job.

updateBackendStorage

inline suspend fun AmplifyBackendClient.updateBackendStorage(crossinline block: UpdateBackendStorageRequest.Builder.() -> Unit): UpdateBackendStorageResponse

Updates an existing backend storage resource.

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

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.