AmplifyUIBuilderClient

Index > AmplifyUIBuilder > AmplifyUIBuilderClient

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

AmplifyUIBuilderClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_amplifyuibuilder.client import AmplifyUIBuilderClient

session = Session()
async with session.client("amplifyuibuilder") as client:
    client: AmplifyUIBuilderClient

Exceptions

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

Usage example

async with session.client("amplifyuibuilder") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.InternalServerException,
        client.InvalidParameterException,
        client.ResourceConflictException,
        client.ResourceNotFoundException,
        client.ServiceQuotaExceededException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_amplifyuibuilder.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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

Method definition

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

close

Closes underlying endpoint connections.

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

Method definition

await def close(
    self,
) -> None:
    ...

create_component

Creates a new component for an Amplify app.

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

Method definition

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

1. See CreateComponentDataTypeDef
2. See CreateComponentResponseTypeDef

Usage example with kwargs

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

parent.create_component(**kwargs)

1. See CreateComponentRequestRequestTypeDef

create_theme

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

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

Method definition

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

1. See CreateThemeDataTypeDef
2. See CreateThemeResponseTypeDef

Usage example with kwargs

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 session.client("amplifyuibuilder").delete_component method. boto3 documentation

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_component(**kwargs)

1. See DeleteComponentRequestRequestTypeDef

delete_theme

Deletes a theme from an Amplify app.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_theme(**kwargs)

1. See DeleteThemeRequestRequestTypeDef

exchange_code_for_token

Exchanges an access code for a token.

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

Method definition

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

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

Usage example with kwargs

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 session.client("amplifyuibuilder").export_components method. boto3 documentation

Method definition

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

1. See ExportComponentsResponseTypeDef

Usage example with kwargs

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

parent.export_components(**kwargs)

1. See ExportComponentsRequestRequestTypeDef

export_themes

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

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

Method definition

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

1. See ExportThemesResponseTypeDef

Usage example with kwargs

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

parent.export_themes(**kwargs)

1. See ExportThemesRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

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

get_component

Returns an existing component for an Amplify app.

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

Method definition

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

1. See GetComponentResponseTypeDef

Usage example with kwargs

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

parent.get_component(**kwargs)

1. See GetComponentRequestRequestTypeDef

get_theme

Returns an existing theme for an Amplify app.

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

Method definition

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

1. See GetThemeResponseTypeDef

Usage example with kwargs

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

parent.get_theme(**kwargs)

1. See GetThemeRequestRequestTypeDef

list_components

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

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

Method definition

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

1. See ListComponentsResponseTypeDef

Usage example with kwargs

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

parent.list_components(**kwargs)

1. See ListComponentsRequestRequestTypeDef

list_themes

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

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

Method definition

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

1. See ListThemesResponseTypeDef

Usage example with kwargs

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

parent.list_themes(**kwargs)

1. See ListThemesRequestRequestTypeDef

refresh_token

Refreshes a previously issued access token that might have expired.

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

Method definition

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

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

Usage example with kwargs

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

parent.refresh_token(**kwargs)

1. See RefreshTokenRequestRequestTypeDef

update_component

Updates an existing component.

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

Method definition

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

1. See UpdateComponentDataTypeDef
2. See UpdateComponentResponseTypeDef

Usage example with kwargs

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

parent.update_component(**kwargs)

1. See UpdateComponentRequestRequestTypeDef

update_theme

Updates an existing theme.

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

Method definition

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

1. See UpdateThemeDataTypeDef
2. See UpdateThemeResponseTypeDef

Usage example with kwargs

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

parent.update_theme(**kwargs)

1. See UpdateThemeRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> AmplifyUIBuilderClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

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

• client.get_paginator("export_components") -> ExportComponentsPaginator
• client.get_paginator("export_themes") -> ExportThemesPaginator
• client.get_paginator("list_components") -> ListComponentsPaginator
• client.get_paginator("list_themes") -> ListThemesPaginator