amplifyuibuilder/aws.sdk.kotlin.services.amplifyuibuilder/AmplifyUiBuilderClient

AmplifyUiBuilderClient

interface AmplifyUiBuilderClient : SdkClient

The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend Amazon Web Services resources.

You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see Introduction in the Amplify Docs.

The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework. For more information about deploying an Amplify application to Amazon Web Services, see the Amplify User Guide.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: AmplifyUiBuilderClient.Config

AmplifyUiBuilderClient's configuration

Functions

createComponent

abstract suspend fun createComponent(input: CreateComponentRequest): CreateComponentResponse

Creates a new component for an Amplify app.

createForm

abstract suspend fun createForm(input: CreateFormRequest): CreateFormResponse

Creates a new form for an Amplify app.

createTheme

abstract suspend fun createTheme(input: CreateThemeRequest): CreateThemeResponse

Creates a theme to apply to the components in an Amplify app.

deleteComponent

abstract suspend fun deleteComponent(input: DeleteComponentRequest): DeleteComponentResponse

Deletes a component from an Amplify app.

deleteForm

abstract suspend fun deleteForm(input: DeleteFormRequest): DeleteFormResponse

Deletes a form from an Amplify app.

deleteTheme

abstract suspend fun deleteTheme(input: DeleteThemeRequest): DeleteThemeResponse

Deletes a theme from an Amplify app.

exchangeCodeForToken

abstract suspend fun exchangeCodeForToken(input: ExchangeCodeForTokenRequest): ExchangeCodeForTokenResponse

This is for internal use.

exportComponents

abstract suspend fun exportComponents(input: ExportComponentsRequest): ExportComponentsResponse

Exports component configurations to code that is ready to integrate into an Amplify app.

exportForms

abstract suspend fun exportForms(input: ExportFormsRequest): ExportFormsResponse

Exports form configurations to code that is ready to integrate into an Amplify app.

exportThemes

abstract suspend fun exportThemes(input: ExportThemesRequest): ExportThemesResponse

Exports theme configurations to code that is ready to integrate into an Amplify app.

getCodegenJob

abstract suspend fun getCodegenJob(input: GetCodegenJobRequest): GetCodegenJobResponse

Returns an existing code generation job.

getComponent

abstract suspend fun getComponent(input: GetComponentRequest): GetComponentResponse

Returns an existing component for an Amplify app.

getForm

abstract suspend fun getForm(input: GetFormRequest): GetFormResponse

Returns an existing form for an Amplify app.

getMetadata

abstract suspend fun getMetadata(input: GetMetadataRequest): GetMetadataResponse

Returns existing metadata for an Amplify app.

getTheme

abstract suspend fun getTheme(input: GetThemeRequest): GetThemeResponse

Returns an existing theme for an Amplify app.

listCodegenJobs

abstract suspend fun listCodegenJobs(input: ListCodegenJobsRequest): ListCodegenJobsResponse

Retrieves a list of code generation jobs for a specified Amplify app and backend environment.

listComponents

abstract suspend fun listComponents(input: ListComponentsRequest): ListComponentsResponse

Retrieves a list of components for a specified Amplify app and backend environment.

listForms

abstract suspend fun listForms(input: ListFormsRequest): ListFormsResponse

Retrieves a list of forms for a specified Amplify app and backend environment.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

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

listThemes

abstract suspend fun listThemes(input: ListThemesRequest): ListThemesResponse

Retrieves a list of themes for a specified Amplify app and backend environment.

putMetadataFlag

abstract suspend fun putMetadataFlag(input: PutMetadataFlagRequest): PutMetadataFlagResponse

Stores the metadata information about a feature on a form.

refreshToken

abstract suspend fun refreshToken(input: RefreshTokenRequest): RefreshTokenResponse

This is for internal use.

startCodegenJob

abstract suspend fun startCodegenJob(input: StartCodegenJobRequest): StartCodegenJobResponse

Starts a code generation job for a specified Amplify app and backend environment.

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).

updateComponent

abstract suspend fun updateComponent(input: UpdateComponentRequest): UpdateComponentResponse

Updates an existing component.

updateForm

abstract suspend fun updateForm(input: UpdateFormRequest): UpdateFormResponse

Updates an existing form.

updateTheme

abstract suspend fun updateTheme(input: UpdateThemeRequest): UpdateThemeResponse

Updates an existing theme.

Inherited functions

expect abstract fun close()

createComponent

inline suspend fun AmplifyUiBuilderClient.createComponent(crossinline block: CreateComponentRequest.Builder.() -> Unit): CreateComponentResponse

Creates a new component for an Amplify app.

createForm

inline suspend fun AmplifyUiBuilderClient.createForm(crossinline block: CreateFormRequest.Builder.() -> Unit): CreateFormResponse

Creates a new form for an Amplify app.

createTheme

inline suspend fun AmplifyUiBuilderClient.createTheme(crossinline block: CreateThemeRequest.Builder.() -> Unit): CreateThemeResponse

Creates a theme to apply to the components in an Amplify app.

deleteComponent

inline suspend fun AmplifyUiBuilderClient.deleteComponent(crossinline block: DeleteComponentRequest.Builder.() -> Unit): DeleteComponentResponse

Deletes a component from an Amplify app.

deleteForm

inline suspend fun AmplifyUiBuilderClient.deleteForm(crossinline block: DeleteFormRequest.Builder.() -> Unit): DeleteFormResponse

Deletes a form from an Amplify app.

deleteTheme

inline suspend fun AmplifyUiBuilderClient.deleteTheme(crossinline block: DeleteThemeRequest.Builder.() -> Unit): DeleteThemeResponse

Deletes a theme from an Amplify app.

exchangeCodeForToken

inline suspend fun AmplifyUiBuilderClient.exchangeCodeForToken(crossinline block: ExchangeCodeForTokenRequest.Builder.() -> Unit): ExchangeCodeForTokenResponse

This is for internal use.

exportComponents

inline suspend fun AmplifyUiBuilderClient.exportComponents(crossinline block: ExportComponentsRequest.Builder.() -> Unit): ExportComponentsResponse

Exports component configurations to code that is ready to integrate into an Amplify app.

exportComponentsPaginated

fun AmplifyUiBuilderClient.exportComponentsPaginated(initialRequest: ExportComponentsRequest): Flow<ExportComponentsResponse>

fun AmplifyUiBuilderClient.exportComponentsPaginated(block: ExportComponentsRequest.Builder.() -> Unit): Flow<ExportComponentsResponse>

Paginate over ExportComponentsResponse results.

exportForms

inline suspend fun AmplifyUiBuilderClient.exportForms(crossinline block: ExportFormsRequest.Builder.() -> Unit): ExportFormsResponse

Exports form configurations to code that is ready to integrate into an Amplify app.

exportFormsPaginated

fun AmplifyUiBuilderClient.exportFormsPaginated(initialRequest: ExportFormsRequest): Flow<ExportFormsResponse>

fun AmplifyUiBuilderClient.exportFormsPaginated(block: ExportFormsRequest.Builder.() -> Unit): Flow<ExportFormsResponse>

Paginate over ExportFormsResponse results.

exportThemes

inline suspend fun AmplifyUiBuilderClient.exportThemes(crossinline block: ExportThemesRequest.Builder.() -> Unit): ExportThemesResponse

Exports theme configurations to code that is ready to integrate into an Amplify app.

exportThemesPaginated

fun AmplifyUiBuilderClient.exportThemesPaginated(initialRequest: ExportThemesRequest): Flow<ExportThemesResponse>

fun AmplifyUiBuilderClient.exportThemesPaginated(block: ExportThemesRequest.Builder.() -> Unit): Flow<ExportThemesResponse>

Paginate over ExportThemesResponse results.

getCodegenJob

inline suspend fun AmplifyUiBuilderClient.getCodegenJob(crossinline block: GetCodegenJobRequest.Builder.() -> Unit): GetCodegenJobResponse

Returns an existing code generation job.

getComponent

inline suspend fun AmplifyUiBuilderClient.getComponent(crossinline block: GetComponentRequest.Builder.() -> Unit): GetComponentResponse

Returns an existing component for an Amplify app.

getForm

inline suspend fun AmplifyUiBuilderClient.getForm(crossinline block: GetFormRequest.Builder.() -> Unit): GetFormResponse

Returns an existing form for an Amplify app.

getMetadata

inline suspend fun AmplifyUiBuilderClient.getMetadata(crossinline block: GetMetadataRequest.Builder.() -> Unit): GetMetadataResponse

Returns existing metadata for an Amplify app.

getTheme

inline suspend fun AmplifyUiBuilderClient.getTheme(crossinline block: GetThemeRequest.Builder.() -> Unit): GetThemeResponse

Returns an existing theme for an Amplify app.

listCodegenJobs

inline suspend fun AmplifyUiBuilderClient.listCodegenJobs(crossinline block: ListCodegenJobsRequest.Builder.() -> Unit): ListCodegenJobsResponse

Retrieves a list of code generation jobs for a specified Amplify app and backend environment.

listCodegenJobsPaginated

fun AmplifyUiBuilderClient.listCodegenJobsPaginated(initialRequest: ListCodegenJobsRequest): Flow<ListCodegenJobsResponse>

fun AmplifyUiBuilderClient.listCodegenJobsPaginated(block: ListCodegenJobsRequest.Builder.() -> Unit): Flow<ListCodegenJobsResponse>

Paginate over ListCodegenJobsResponse results.

listComponents

inline suspend fun AmplifyUiBuilderClient.listComponents(crossinline block: ListComponentsRequest.Builder.() -> Unit): ListComponentsResponse

Retrieves a list of components for a specified Amplify app and backend environment.

listComponentsPaginated

fun AmplifyUiBuilderClient.listComponentsPaginated(initialRequest: ListComponentsRequest): Flow<ListComponentsResponse>

fun AmplifyUiBuilderClient.listComponentsPaginated(block: ListComponentsRequest.Builder.() -> Unit): Flow<ListComponentsResponse>

Paginate over ListComponentsResponse results.

listForms

inline suspend fun AmplifyUiBuilderClient.listForms(crossinline block: ListFormsRequest.Builder.() -> Unit): ListFormsResponse

Retrieves a list of forms for a specified Amplify app and backend environment.

listFormsPaginated

fun AmplifyUiBuilderClient.listFormsPaginated(initialRequest: ListFormsRequest): Flow<ListFormsResponse>

fun AmplifyUiBuilderClient.listFormsPaginated(block: ListFormsRequest.Builder.() -> Unit): Flow<ListFormsResponse>

Paginate over ListFormsResponse results.

listTagsForResource

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

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

listThemes

inline suspend fun AmplifyUiBuilderClient.listThemes(crossinline block: ListThemesRequest.Builder.() -> Unit): ListThemesResponse

Retrieves a list of themes for a specified Amplify app and backend environment.

listThemesPaginated

fun AmplifyUiBuilderClient.listThemesPaginated(initialRequest: ListThemesRequest): Flow<ListThemesResponse>

fun AmplifyUiBuilderClient.listThemesPaginated(block: ListThemesRequest.Builder.() -> Unit): Flow<ListThemesResponse>

Paginate over ListThemesResponse results.

putMetadataFlag

inline suspend fun AmplifyUiBuilderClient.putMetadataFlag(crossinline block: PutMetadataFlagRequest.Builder.() -> Unit): PutMetadataFlagResponse

Stores the metadata information about a feature on a form.

refreshToken

inline suspend fun AmplifyUiBuilderClient.refreshToken(crossinline block: RefreshTokenRequest.Builder.() -> Unit): RefreshTokenResponse

This is for internal use.

startCodegenJob

inline suspend fun AmplifyUiBuilderClient.startCodegenJob(crossinline block: StartCodegenJobRequest.Builder.() -> Unit): StartCodegenJobResponse

Starts a code generation job for a specified Amplify app and backend environment.

tagResource

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

Tags the resource with a tag key and value.

untagResource

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

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

updateComponent

inline suspend fun AmplifyUiBuilderClient.updateComponent(crossinline block: UpdateComponentRequest.Builder.() -> Unit): UpdateComponentResponse

Updates an existing component.

updateForm

inline suspend fun AmplifyUiBuilderClient.updateForm(crossinline block: UpdateFormRequest.Builder.() -> Unit): UpdateFormResponse

Updates an existing form.

updateTheme

inline suspend fun AmplifyUiBuilderClient.updateTheme(crossinline block: UpdateThemeRequest.Builder.() -> Unit): UpdateThemeResponse

Updates an existing theme.

withConfig

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

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.