amplifyuibuilder/aws.sdk.kotlin.services.amplifyuibuilder

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

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.

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.

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.

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.

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.

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.

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.

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.