AmplifyUIBuilderClient

Index > AmplifyUIBuilder > AmplifyUIBuilderClient

Auto-generated documentation for AmplifyUIBuilder type annotations stubs module types-boto3-amplifyuibuilder.

AmplifyUIBuilderClient

Type annotations and code completion for boto3.client("amplifyuibuilder"). boto3 documentation

# AmplifyUIBuilderClient usage example

from boto3.session import Session
from types_boto3_amplifyuibuilder.client import AmplifyUIBuilderClient

def get_amplifyuibuilder_client() -> AmplifyUIBuilderClient:
    return Session().client("amplifyuibuilder")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("amplifyuibuilder").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("amplifyuibuilder")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidParameterException,
    client.exceptions.ResourceConflictException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.UnauthorizedException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_amplifyuibuilder.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("amplifyuibuilder").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("amplifyuibuilder").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_component

Creates a new component for an Amplify app.

Type annotations and code completion for boto3.client("amplifyuibuilder").create_component method. boto3 documentation

# create_component method definition

def create_component(
    self,
    *,
    appId: str,
    environmentName: str,
    componentToCreate: CreateComponentDataTypeDef,  # (1)
    clientToken: str = ...,
) -> CreateComponentResponseTypeDef:  # (2)
    ...

1. See CreateComponentDataTypeDef
2. See CreateComponentResponseTypeDef

# create_component method usage example with argument unpacking

kwargs: CreateComponentRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "componentToCreate": ...,
}

parent.create_component(**kwargs)

1. See CreateComponentRequestRequestTypeDef

create_form

Creates a new form for an Amplify app.

Type annotations and code completion for boto3.client("amplifyuibuilder").create_form method. boto3 documentation

# create_form method definition

def create_form(
    self,
    *,
    appId: str,
    environmentName: str,
    formToCreate: CreateFormDataTypeDef,  # (1)
    clientToken: str = ...,
) -> CreateFormResponseTypeDef:  # (2)
    ...

1. See CreateFormDataTypeDef
2. See CreateFormResponseTypeDef

# create_form method usage example with argument unpacking

kwargs: CreateFormRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "formToCreate": ...,
}

parent.create_form(**kwargs)

1. See CreateFormRequestRequestTypeDef

create_theme

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

Type annotations and code completion for boto3.client("amplifyuibuilder").create_theme method. boto3 documentation

# create_theme method definition

def create_theme(
    self,
    *,
    appId: str,
    environmentName: str,
    themeToCreate: CreateThemeDataTypeDef,  # (1)
    clientToken: str = ...,
) -> CreateThemeResponseTypeDef:  # (2)
    ...

1. See CreateThemeDataTypeDef
2. See CreateThemeResponseTypeDef

# create_theme method usage example with argument unpacking

kwargs: CreateThemeRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "themeToCreate": ...,
}

parent.create_theme(**kwargs)

1. See CreateThemeRequestRequestTypeDef

delete_component

Deletes a component from an Amplify app.

Type annotations and code completion for boto3.client("amplifyuibuilder").delete_component method. boto3 documentation

# delete_component method definition

def delete_component(
    self,
    *,
    appId: str,
    environmentName: str,
    id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_component method usage example with argument unpacking

kwargs: DeleteComponentRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "id": ...,
}

parent.delete_component(**kwargs)

1. See DeleteComponentRequestRequestTypeDef

delete_form

Deletes a form from an Amplify app.

Type annotations and code completion for boto3.client("amplifyuibuilder").delete_form method. boto3 documentation

# delete_form method definition

def delete_form(
    self,
    *,
    appId: str,
    environmentName: str,
    id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_form method usage example with argument unpacking

kwargs: DeleteFormRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "id": ...,
}

parent.delete_form(**kwargs)

1. See DeleteFormRequestRequestTypeDef

delete_theme

Deletes a theme from an Amplify app.

Type annotations and code completion for boto3.client("amplifyuibuilder").delete_theme method. boto3 documentation

# delete_theme method definition

def delete_theme(
    self,
    *,
    appId: str,
    environmentName: str,
    id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_theme method usage example with argument unpacking

kwargs: DeleteThemeRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "id": ...,
}

parent.delete_theme(**kwargs)

1. See DeleteThemeRequestRequestTypeDef

exchange_code_for_token

This is for internal use.

Type annotations and code completion for boto3.client("amplifyuibuilder").exchange_code_for_token method. boto3 documentation

# exchange_code_for_token method definition

def exchange_code_for_token(
    self,
    *,
    provider: TokenProvidersType,  # (1)
    request: ExchangeCodeForTokenRequestBodyTypeDef,  # (2)
) -> ExchangeCodeForTokenResponseTypeDef:  # (3)
    ...

1. See TokenProvidersType
2. See ExchangeCodeForTokenRequestBodyTypeDef
3. See ExchangeCodeForTokenResponseTypeDef

# exchange_code_for_token method usage example with argument unpacking

kwargs: ExchangeCodeForTokenRequestRequestTypeDef = {  # (1)
    "provider": ...,
    "request": ...,
}

parent.exchange_code_for_token(**kwargs)

1. See ExchangeCodeForTokenRequestRequestTypeDef

export_components

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

Type annotations and code completion for boto3.client("amplifyuibuilder").export_components method. boto3 documentation

# export_components method definition

def export_components(
    self,
    *,
    appId: str,
    environmentName: str,
    nextToken: str = ...,
) -> ExportComponentsResponseTypeDef:  # (1)
    ...

1. See ExportComponentsResponseTypeDef

# export_components method usage example with argument unpacking

kwargs: ExportComponentsRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
}

parent.export_components(**kwargs)

1. See ExportComponentsRequestRequestTypeDef

export_forms

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

Type annotations and code completion for boto3.client("amplifyuibuilder").export_forms method. boto3 documentation

# export_forms method definition

def export_forms(
    self,
    *,
    appId: str,
    environmentName: str,
    nextToken: str = ...,
) -> ExportFormsResponseTypeDef:  # (1)
    ...

1. See ExportFormsResponseTypeDef

# export_forms method usage example with argument unpacking

kwargs: ExportFormsRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
}

parent.export_forms(**kwargs)

1. See ExportFormsRequestRequestTypeDef

export_themes

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

Type annotations and code completion for boto3.client("amplifyuibuilder").export_themes method. boto3 documentation

# export_themes method definition

def export_themes(
    self,
    *,
    appId: str,
    environmentName: str,
    nextToken: str = ...,
) -> ExportThemesResponseTypeDef:  # (1)
    ...

1. See ExportThemesResponseTypeDef

# export_themes method usage example with argument unpacking

kwargs: ExportThemesRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
}

parent.export_themes(**kwargs)

1. See ExportThemesRequestRequestTypeDef

get_codegen_job

Returns an existing code generation job.

Type annotations and code completion for boto3.client("amplifyuibuilder").get_codegen_job method. boto3 documentation

# get_codegen_job method definition

def get_codegen_job(
    self,
    *,
    appId: str,
    environmentName: str,
    id: str,
) -> GetCodegenJobResponseTypeDef:  # (1)
    ...

1. See GetCodegenJobResponseTypeDef

# get_codegen_job method usage example with argument unpacking

kwargs: GetCodegenJobRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "id": ...,
}

parent.get_codegen_job(**kwargs)

1. See GetCodegenJobRequestRequestTypeDef

get_component

Returns an existing component for an Amplify app.

Type annotations and code completion for boto3.client("amplifyuibuilder").get_component method. boto3 documentation

# get_component method definition

def get_component(
    self,
    *,
    appId: str,
    environmentName: str,
    id: str,
) -> GetComponentResponseTypeDef:  # (1)
    ...

1. See GetComponentResponseTypeDef

# get_component method usage example with argument unpacking

kwargs: GetComponentRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "id": ...,
}

parent.get_component(**kwargs)

1. See GetComponentRequestRequestTypeDef

get_form

Returns an existing form for an Amplify app.

Type annotations and code completion for boto3.client("amplifyuibuilder").get_form method. boto3 documentation

# get_form method definition

def get_form(
    self,
    *,
    appId: str,
    environmentName: str,
    id: str,
) -> GetFormResponseTypeDef:  # (1)
    ...

1. See GetFormResponseTypeDef

# get_form method usage example with argument unpacking

kwargs: GetFormRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "id": ...,
}

parent.get_form(**kwargs)

1. See GetFormRequestRequestTypeDef

get_metadata

Returns existing metadata for an Amplify app.

Type annotations and code completion for boto3.client("amplifyuibuilder").get_metadata method. boto3 documentation

# get_metadata method definition

def get_metadata(
    self,
    *,
    appId: str,
    environmentName: str,
) -> GetMetadataResponseTypeDef:  # (1)
    ...

1. See GetMetadataResponseTypeDef

# get_metadata method usage example with argument unpacking

kwargs: GetMetadataRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
}

parent.get_metadata(**kwargs)

1. See GetMetadataRequestRequestTypeDef

get_theme

Returns an existing theme for an Amplify app.

Type annotations and code completion for boto3.client("amplifyuibuilder").get_theme method. boto3 documentation

# get_theme method definition

def get_theme(
    self,
    *,
    appId: str,
    environmentName: str,
    id: str,
) -> GetThemeResponseTypeDef:  # (1)
    ...

1. See GetThemeResponseTypeDef

# get_theme method usage example with argument unpacking

kwargs: GetThemeRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "id": ...,
}

parent.get_theme(**kwargs)

1. See GetThemeRequestRequestTypeDef

list_codegen_jobs

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

Type annotations and code completion for boto3.client("amplifyuibuilder").list_codegen_jobs method. boto3 documentation

# list_codegen_jobs method definition

def list_codegen_jobs(
    self,
    *,
    appId: str,
    environmentName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListCodegenJobsResponseTypeDef:  # (1)
    ...

1. See ListCodegenJobsResponseTypeDef

# list_codegen_jobs method usage example with argument unpacking

kwargs: ListCodegenJobsRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
}

parent.list_codegen_jobs(**kwargs)

1. See ListCodegenJobsRequestRequestTypeDef

list_components

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

Type annotations and code completion for boto3.client("amplifyuibuilder").list_components method. boto3 documentation

# list_components method definition

def list_components(
    self,
    *,
    appId: str,
    environmentName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListComponentsResponseTypeDef:  # (1)
    ...

1. See ListComponentsResponseTypeDef

# list_components method usage example with argument unpacking

kwargs: ListComponentsRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
}

parent.list_components(**kwargs)

1. See ListComponentsRequestRequestTypeDef

list_forms

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

Type annotations and code completion for boto3.client("amplifyuibuilder").list_forms method. boto3 documentation

# list_forms method definition

def list_forms(
    self,
    *,
    appId: str,
    environmentName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListFormsResponseTypeDef:  # (1)
    ...

1. See ListFormsResponseTypeDef

# list_forms method usage example with argument unpacking

kwargs: ListFormsRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
}

parent.list_forms(**kwargs)

1. See ListFormsRequestRequestTypeDef

list_tags_for_resource

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

Type annotations and code completion for boto3.client("amplifyuibuilder").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_themes

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

Type annotations and code completion for boto3.client("amplifyuibuilder").list_themes method. boto3 documentation

# list_themes method definition

def list_themes(
    self,
    *,
    appId: str,
    environmentName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListThemesResponseTypeDef:  # (1)
    ...

1. See ListThemesResponseTypeDef

# list_themes method usage example with argument unpacking

kwargs: ListThemesRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
}

parent.list_themes(**kwargs)

1. See ListThemesRequestRequestTypeDef

put_metadata_flag

Stores the metadata information about a feature on a form.

Type annotations and code completion for boto3.client("amplifyuibuilder").put_metadata_flag method. boto3 documentation

# put_metadata_flag method definition

def put_metadata_flag(
    self,
    *,
    appId: str,
    environmentName: str,
    featureName: str,
    body: PutMetadataFlagBodyTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See PutMetadataFlagBodyTypeDef
2. See EmptyResponseMetadataTypeDef

# put_metadata_flag method usage example with argument unpacking

kwargs: PutMetadataFlagRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "featureName": ...,
    "body": ...,
}

parent.put_metadata_flag(**kwargs)

1. See PutMetadataFlagRequestRequestTypeDef

refresh_token

This is for internal use.

Type annotations and code completion for boto3.client("amplifyuibuilder").refresh_token method. boto3 documentation

# refresh_token method definition

def refresh_token(
    self,
    *,
    provider: TokenProvidersType,  # (1)
    refreshTokenBody: RefreshTokenRequestBodyTypeDef,  # (2)
) -> RefreshTokenResponseTypeDef:  # (3)
    ...

1. See TokenProvidersType
2. See RefreshTokenRequestBodyTypeDef
3. See RefreshTokenResponseTypeDef

# refresh_token method usage example with argument unpacking

kwargs: RefreshTokenRequestRequestTypeDef = {  # (1)
    "provider": ...,
    "refreshTokenBody": ...,
}

parent.refresh_token(**kwargs)

1. See RefreshTokenRequestRequestTypeDef

start_codegen_job

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

Type annotations and code completion for boto3.client("amplifyuibuilder").start_codegen_job method. boto3 documentation

# start_codegen_job method definition

def start_codegen_job(
    self,
    *,
    appId: str,
    environmentName: str,
    codegenJobToCreate: StartCodegenJobDataTypeDef,  # (1)
    clientToken: str = ...,
) -> StartCodegenJobResponseTypeDef:  # (2)
    ...

1. See StartCodegenJobDataTypeDef
2. See StartCodegenJobResponseTypeDef

# start_codegen_job method usage example with argument unpacking

kwargs: StartCodegenJobRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "codegenJobToCreate": ...,
}

parent.start_codegen_job(**kwargs)

1. See StartCodegenJobRequestRequestTypeDef

tag_resource

Tags the resource with a tag key and value.

Type annotations and code completion for boto3.client("amplifyuibuilder").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

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

Type annotations and code completion for boto3.client("amplifyuibuilder").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_component

Updates an existing component.

Type annotations and code completion for boto3.client("amplifyuibuilder").update_component method. boto3 documentation

# update_component method definition

def update_component(
    self,
    *,
    appId: str,
    environmentName: str,
    id: str,
    updatedComponent: UpdateComponentDataTypeDef,  # (1)
    clientToken: str = ...,
) -> UpdateComponentResponseTypeDef:  # (2)
    ...

1. See UpdateComponentDataTypeDef
2. See UpdateComponentResponseTypeDef

# update_component method usage example with argument unpacking

kwargs: UpdateComponentRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "id": ...,
    "updatedComponent": ...,
}

parent.update_component(**kwargs)

1. See UpdateComponentRequestRequestTypeDef

update_form

Updates an existing form.

Type annotations and code completion for boto3.client("amplifyuibuilder").update_form method. boto3 documentation

# update_form method definition

def update_form(
    self,
    *,
    appId: str,
    environmentName: str,
    id: str,
    updatedForm: UpdateFormDataTypeDef,  # (1)
    clientToken: str = ...,
) -> UpdateFormResponseTypeDef:  # (2)
    ...

1. See UpdateFormDataTypeDef
2. See UpdateFormResponseTypeDef

# update_form method usage example with argument unpacking

kwargs: UpdateFormRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "id": ...,
    "updatedForm": ...,
}

parent.update_form(**kwargs)

1. See UpdateFormRequestRequestTypeDef

update_theme

Updates an existing theme.

Type annotations and code completion for boto3.client("amplifyuibuilder").update_theme method. boto3 documentation

# update_theme method definition

def update_theme(
    self,
    *,
    appId: str,
    environmentName: str,
    id: str,
    updatedTheme: UpdateThemeDataTypeDef,  # (1)
    clientToken: str = ...,
) -> UpdateThemeResponseTypeDef:  # (2)
    ...

1. See UpdateThemeDataTypeDef
2. See UpdateThemeResponseTypeDef

# update_theme method usage example with argument unpacking

kwargs: UpdateThemeRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
    "id": ...,
    "updatedTheme": ...,
}

parent.update_theme(**kwargs)

1. See UpdateThemeRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("amplifyuibuilder").get_paginator method with overloads.

• client.get_paginator("export_components") -> ExportComponentsPaginator
• client.get_paginator("export_forms") -> ExportFormsPaginator
• client.get_paginator("export_themes") -> ExportThemesPaginator
• client.get_paginator("list_codegen_jobs") -> ListCodegenJobsPaginator
• client.get_paginator("list_components") -> ListComponentsPaginator
• client.get_paginator("list_forms") -> ListFormsPaginator
• client.get_paginator("list_themes") -> ListThemesPaginator