Typed dictionaries

Index > AmplifyUIBuilder > Typed dictionaries

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

MutationActionSetStateParameterTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import MutationActionSetStateParameterTypeDef

def get_value() -> MutationActionSetStateParameterTypeDef:
    return {
        "componentName": ...,
        "property": ...,
        "set": ...,
    }

Definition

class MutationActionSetStateParameterTypeDef(TypedDict):
    componentName: str,
    property: str,
    set: ComponentPropertyTypeDef,  # (1)

1. See ComponentPropertyTypeDef

ComponentBindingPropertiesValuePropertiesTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentBindingPropertiesValuePropertiesTypeDef

def get_value() -> ComponentBindingPropertiesValuePropertiesTypeDef:
    return {
        "bucket": ...,
    }

Definition

class ComponentBindingPropertiesValuePropertiesTypeDef(TypedDict):
    bucket: NotRequired[str],
    defaultValue: NotRequired[str],
    field: NotRequired[str],
    key: NotRequired[str],
    model: NotRequired[str],
    predicates: NotRequired[Sequence[PredicateTypeDef]],  # (1)
    slotName: NotRequired[str],
    userAttribute: NotRequired[str],

1. See PredicateTypeDef

ComponentConditionPropertyTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentConditionPropertyTypeDef

def get_value() -> ComponentConditionPropertyTypeDef:
    return {
        "else": ...,
    }

Definition

class ComponentConditionPropertyTypeDef(TypedDict):
    else: NotRequired[ComponentPropertyTypeDef],  # (1)
    field: NotRequired[str],
    operand: NotRequired[str],
    operandType: NotRequired[str],
    operator: NotRequired[str],
    property: NotRequired[str],
    then: NotRequired[ComponentPropertyTypeDef],  # (1)

1. See ComponentPropertyTypeDef
2. See ComponentPropertyTypeDef

SortPropertyTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import SortPropertyTypeDef

def get_value() -> SortPropertyTypeDef:
    return {
        "direction": ...,
        "field": ...,
    }

Definition

class SortPropertyTypeDef(TypedDict):
    direction: SortDirectionType,  # (1)
    field: str,

1. See SortDirectionType

ComponentPropertyBindingPropertiesTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentPropertyBindingPropertiesTypeDef

def get_value() -> ComponentPropertyBindingPropertiesTypeDef:
    return {
        "property": ...,
    }

Definition

class ComponentPropertyBindingPropertiesTypeDef(TypedDict):
    property: str,
    field: NotRequired[str],

FormBindingElementTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import FormBindingElementTypeDef

def get_value() -> FormBindingElementTypeDef:
    return {
        "element": ...,
        "property": ...,
    }

Definition

class FormBindingElementTypeDef(TypedDict):
    element: str,
    property: str,

ComponentSummaryTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentSummaryTypeDef

def get_value() -> ComponentSummaryTypeDef:
    return {
        "appId": ...,
        "componentType": ...,
        "environmentName": ...,
        "id": ...,
        "name": ...,
    }

Definition

class ComponentSummaryTypeDef(TypedDict):
    appId: str,
    componentType: str,
    environmentName: str,
    id: str,
    name: str,

ComponentVariantTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentVariantTypeDef

def get_value() -> ComponentVariantTypeDef:
    return {
        "overrides": ...,
    }

Definition

class ComponentVariantTypeDef(TypedDict):
    overrides: NotRequired[Mapping[str, Mapping[str, str]]],
    variantValues: NotRequired[Mapping[str, str]],

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

FormDataTypeConfigTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import FormDataTypeConfigTypeDef

def get_value() -> FormDataTypeConfigTypeDef:
    return {
        "dataSourceType": ...,
        "dataTypeName": ...,
    }

Definition

class FormDataTypeConfigTypeDef(TypedDict):
    dataSourceType: FormDataSourceTypeType,  # (1)
    dataTypeName: str,

1. See FormDataSourceTypeType

CreateThemeDataTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import CreateThemeDataTypeDef

def get_value() -> CreateThemeDataTypeDef:
    return {
        "name": ...,
        "values": ...,
    }

Definition

class CreateThemeDataTypeDef(TypedDict):
    name: str,
    values: Sequence[ThemeValuesTypeDef],  # (1)
    overrides: NotRequired[Sequence[ThemeValuesTypeDef]],  # (1)
    tags: NotRequired[Mapping[str, str]],

1. See ThemeValuesTypeDef
2. See ThemeValuesTypeDef

ThemeTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ThemeTypeDef

def get_value() -> ThemeTypeDef:
    return {
        "appId": ...,
        "createdAt": ...,
        "environmentName": ...,
        "id": ...,
        "name": ...,
        "values": ...,
    }

Definition

class ThemeTypeDef(TypedDict):
    appId: str,
    createdAt: datetime,
    environmentName: str,
    id: str,
    name: str,
    values: List[ThemeValuesTypeDef],  # (1)
    modifiedAt: NotRequired[datetime],
    overrides: NotRequired[List[ThemeValuesTypeDef]],  # (1)
    tags: NotRequired[Dict[str, str]],

1. See ThemeValuesTypeDef
2. See ThemeValuesTypeDef

DeleteComponentRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import DeleteComponentRequestRequestTypeDef

def get_value() -> DeleteComponentRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
        "id": ...,
    }

Definition

class DeleteComponentRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    id: str,

DeleteFormRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import DeleteFormRequestRequestTypeDef

def get_value() -> DeleteFormRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
        "id": ...,
    }

Definition

class DeleteFormRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    id: str,

DeleteThemeRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import DeleteThemeRequestRequestTypeDef

def get_value() -> DeleteThemeRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
        "id": ...,
    }

Definition

class DeleteThemeRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    id: str,

ExchangeCodeForTokenRequestBodyTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ExchangeCodeForTokenRequestBodyTypeDef

def get_value() -> ExchangeCodeForTokenRequestBodyTypeDef:
    return {
        "code": ...,
        "redirectUri": ...,
    }

Definition

class ExchangeCodeForTokenRequestBodyTypeDef(TypedDict):
    code: str,
    redirectUri: str,

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

Definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ExportComponentsRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ExportComponentsRequestRequestTypeDef

def get_value() -> ExportComponentsRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
    }

Definition

class ExportComponentsRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    nextToken: NotRequired[str],

ExportFormsRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ExportFormsRequestRequestTypeDef

def get_value() -> ExportFormsRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
    }

Definition

class ExportFormsRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    nextToken: NotRequired[str],

ExportThemesRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ExportThemesRequestRequestTypeDef

def get_value() -> ExportThemesRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
    }

Definition

class ExportThemesRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    nextToken: NotRequired[str],

FieldPositionTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import FieldPositionTypeDef

def get_value() -> FieldPositionTypeDef:
    return {
        "below": ...,
    }

Definition

class FieldPositionTypeDef(TypedDict):
    below: NotRequired[str],
    fixed: NotRequired[FixedPositionType],  # (1)
    rightOf: NotRequired[str],

1. See FixedPositionType

FieldValidationConfigurationTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import FieldValidationConfigurationTypeDef

def get_value() -> FieldValidationConfigurationTypeDef:
    return {
        "type": ...,
    }

Definition

class FieldValidationConfigurationTypeDef(TypedDict):
    type: str,
    numValues: NotRequired[Sequence[int]],
    strValues: NotRequired[Sequence[str]],
    validationMessage: NotRequired[str],

FormInputValuePropertyTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import FormInputValuePropertyTypeDef

def get_value() -> FormInputValuePropertyTypeDef:
    return {
        "value": ...,
    }

Definition

class FormInputValuePropertyTypeDef(TypedDict):
    value: NotRequired[str],

FormStyleConfigTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import FormStyleConfigTypeDef

def get_value() -> FormStyleConfigTypeDef:
    return {
        "tokenReference": ...,
    }

Definition

class FormStyleConfigTypeDef(TypedDict):
    tokenReference: NotRequired[str],
    value: NotRequired[str],

GetComponentRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import GetComponentRequestRequestTypeDef

def get_value() -> GetComponentRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
        "id": ...,
    }

Definition

class GetComponentRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    id: str,

GetFormRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import GetFormRequestRequestTypeDef

def get_value() -> GetFormRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
        "id": ...,
    }

Definition

class GetFormRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    id: str,

GetMetadataRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import GetMetadataRequestRequestTypeDef

def get_value() -> GetMetadataRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
    }

Definition

class GetMetadataRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,

GetThemeRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import GetThemeRequestRequestTypeDef

def get_value() -> GetThemeRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
        "id": ...,
    }

Definition

class GetThemeRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    id: str,

ListComponentsRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ListComponentsRequestRequestTypeDef

def get_value() -> ListComponentsRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
    }

Definition

class ListComponentsRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListFormsRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ListFormsRequestRequestTypeDef

def get_value() -> ListFormsRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
    }

Definition

class ListFormsRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListThemesRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ListThemesRequestRequestTypeDef

def get_value() -> ListThemesRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
    }

Definition

class ListThemesRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ThemeSummaryTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ThemeSummaryTypeDef

def get_value() -> ThemeSummaryTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
        "id": ...,
        "name": ...,
    }

Definition

class ThemeSummaryTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    id: str,
    name: str,

PredicateTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import PredicateTypeDef

def get_value() -> PredicateTypeDef:
    return {
        "and": ...,
    }

Definition

class PredicateTypeDef(TypedDict):
    and: NotRequired[Sequence[PredicateTypeDef]],  # (1)
    field: NotRequired[str],
    operand: NotRequired[str],
    operator: NotRequired[str],
    or: NotRequired[Sequence[PredicateTypeDef]],  # (1)

1. See PredicateTypeDef
2. See PredicateTypeDef

PutMetadataFlagBodyTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import PutMetadataFlagBodyTypeDef

def get_value() -> PutMetadataFlagBodyTypeDef:
    return {
        "newValue": ...,
    }

Definition

class PutMetadataFlagBodyTypeDef(TypedDict):
    newValue: str,

RefreshTokenRequestBodyTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import RefreshTokenRequestBodyTypeDef

def get_value() -> RefreshTokenRequestBodyTypeDef:
    return {
        "token": ...,
    }

Definition

class RefreshTokenRequestBodyTypeDef(TypedDict):
    token: str,

ThemeValueTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ThemeValueTypeDef

def get_value() -> ThemeValueTypeDef:
    return {
        "children": ...,
    }

Definition

class ThemeValueTypeDef(TypedDict):
    children: NotRequired[Sequence[ThemeValuesTypeDef]],  # (1)
    value: NotRequired[str],

1. See ThemeValuesTypeDef

ThemeValuesTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ThemeValuesTypeDef

def get_value() -> ThemeValuesTypeDef:
    return {
        "key": ...,
    }

Definition

class ThemeValuesTypeDef(TypedDict):
    key: NotRequired[str],
    value: NotRequired[ThemeValueTypeDef],  # (1)

1. See ThemeValueTypeDef

UpdateThemeDataTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateThemeDataTypeDef

def get_value() -> UpdateThemeDataTypeDef:
    return {
        "values": ...,
    }

Definition

class UpdateThemeDataTypeDef(TypedDict):
    values: Sequence[ThemeValuesTypeDef],  # (1)
    id: NotRequired[str],
    name: NotRequired[str],
    overrides: NotRequired[Sequence[ThemeValuesTypeDef]],  # (1)

1. See ThemeValuesTypeDef
2. See ThemeValuesTypeDef

ActionParametersTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ActionParametersTypeDef

def get_value() -> ActionParametersTypeDef:
    return {
        "anchor": ...,
    }

Definition

class ActionParametersTypeDef(TypedDict):
    anchor: NotRequired[ComponentPropertyTypeDef],  # (1)
    fields: NotRequired[Mapping[str, ComponentPropertyTypeDef]],  # (2)
    global: NotRequired[ComponentPropertyTypeDef],  # (1)
    id: NotRequired[ComponentPropertyTypeDef],  # (1)
    model: NotRequired[str],
    state: NotRequired[MutationActionSetStateParameterTypeDef],  # (5)
    target: NotRequired[ComponentPropertyTypeDef],  # (1)
    type: NotRequired[ComponentPropertyTypeDef],  # (1)
    url: NotRequired[ComponentPropertyTypeDef],  # (1)

1. See ComponentPropertyTypeDef
2. See ComponentPropertyTypeDef
3. See ComponentPropertyTypeDef
4. See ComponentPropertyTypeDef
5. See MutationActionSetStateParameterTypeDef
6. See ComponentPropertyTypeDef
7. See ComponentPropertyTypeDef
8. See ComponentPropertyTypeDef

ComponentBindingPropertiesValueTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentBindingPropertiesValueTypeDef

def get_value() -> ComponentBindingPropertiesValueTypeDef:
    return {
        "bindingProperties": ...,
    }

Definition

class ComponentBindingPropertiesValueTypeDef(TypedDict):
    bindingProperties: NotRequired[ComponentBindingPropertiesValuePropertiesTypeDef],  # (1)
    defaultValue: NotRequired[str],
    type: NotRequired[str],

1. See ComponentBindingPropertiesValuePropertiesTypeDef

ComponentDataConfigurationTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentDataConfigurationTypeDef

def get_value() -> ComponentDataConfigurationTypeDef:
    return {
        "model": ...,
    }

Definition

class ComponentDataConfigurationTypeDef(TypedDict):
    model: str,
    identifiers: NotRequired[Sequence[str]],
    predicate: NotRequired[PredicateTypeDef],  # (1)
    sort: NotRequired[Sequence[SortPropertyTypeDef]],  # (2)

1. See PredicateTypeDef
2. See SortPropertyTypeDef

ComponentPropertyTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentPropertyTypeDef

def get_value() -> ComponentPropertyTypeDef:
    return {
        "bindingProperties": ...,
    }

Definition

class ComponentPropertyTypeDef(TypedDict):
    bindingProperties: NotRequired[ComponentPropertyBindingPropertiesTypeDef],  # (1)
    bindings: NotRequired[Mapping[str, FormBindingElementTypeDef]],  # (2)
    collectionBindingProperties: NotRequired[ComponentPropertyBindingPropertiesTypeDef],  # (1)
    componentName: NotRequired[str],
    concat: NotRequired[Sequence[ComponentPropertyTypeDef]],  # (4)
    condition: NotRequired[ComponentConditionPropertyTypeDef],  # (5)
    configured: NotRequired[bool],
    defaultValue: NotRequired[str],
    event: NotRequired[str],
    importedValue: NotRequired[str],
    model: NotRequired[str],
    property: NotRequired[str],
    type: NotRequired[str],
    userAttribute: NotRequired[str],
    value: NotRequired[str],

1. See ComponentPropertyBindingPropertiesTypeDef
2. See FormBindingElementTypeDef
3. See ComponentPropertyBindingPropertiesTypeDef
4. See ComponentPropertyTypeDef
5. See ComponentConditionPropertyTypeDef

EmptyResponseMetadataTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }

Definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ExchangeCodeForTokenResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ExchangeCodeForTokenResponseTypeDef

def get_value() -> ExchangeCodeForTokenResponseTypeDef:
    return {
        "accessToken": ...,
        "expiresIn": ...,
        "refreshToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ExchangeCodeForTokenResponseTypeDef(TypedDict):
    accessToken: str,
    expiresIn: int,
    refreshToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetMetadataResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import GetMetadataResponseTypeDef

def get_value() -> GetMetadataResponseTypeDef:
    return {
        "features": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetMetadataResponseTypeDef(TypedDict):
    features: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ListComponentsResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ListComponentsResponseTypeDef

def get_value() -> ListComponentsResponseTypeDef:
    return {
        "entities": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListComponentsResponseTypeDef(TypedDict):
    entities: List[ComponentSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComponentSummaryTypeDef
2. See ResponseMetadataTypeDef

RefreshTokenResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import RefreshTokenResponseTypeDef

def get_value() -> RefreshTokenResponseTypeDef:
    return {
        "accessToken": ...,
        "expiresIn": ...,
        "ResponseMetadata": ...,
    }

Definition

class RefreshTokenResponseTypeDef(TypedDict):
    accessToken: str,
    expiresIn: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

FormSummaryTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import FormSummaryTypeDef

def get_value() -> FormSummaryTypeDef:
    return {
        "appId": ...,
        "dataType": ...,
        "environmentName": ...,
        "formActionType": ...,
        "id": ...,
        "name": ...,
    }

Definition

class FormSummaryTypeDef(TypedDict):
    appId: str,
    dataType: FormDataTypeConfigTypeDef,  # (1)
    environmentName: str,
    formActionType: FormActionTypeType,  # (2)
    id: str,
    name: str,

1. See FormDataTypeConfigTypeDef
2. See FormActionTypeType

CreateThemeRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import CreateThemeRequestRequestTypeDef

def get_value() -> CreateThemeRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
        "themeToCreate": ...,
    }

Definition

class CreateThemeRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    themeToCreate: CreateThemeDataTypeDef,  # (1)
    clientToken: NotRequired[str],

1. See CreateThemeDataTypeDef

CreateThemeResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import CreateThemeResponseTypeDef

def get_value() -> CreateThemeResponseTypeDef:
    return {
        "entity": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateThemeResponseTypeDef(TypedDict):
    entity: ThemeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ThemeTypeDef
2. See ResponseMetadataTypeDef

ExportThemesResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ExportThemesResponseTypeDef

def get_value() -> ExportThemesResponseTypeDef:
    return {
        "entities": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ExportThemesResponseTypeDef(TypedDict):
    entities: List[ThemeTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ThemeTypeDef
2. See ResponseMetadataTypeDef

GetThemeResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import GetThemeResponseTypeDef

def get_value() -> GetThemeResponseTypeDef:
    return {
        "theme": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetThemeResponseTypeDef(TypedDict):
    theme: ThemeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ThemeTypeDef
2. See ResponseMetadataTypeDef

UpdateThemeResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateThemeResponseTypeDef

def get_value() -> UpdateThemeResponseTypeDef:
    return {
        "entity": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateThemeResponseTypeDef(TypedDict):
    entity: ThemeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ThemeTypeDef
2. See ResponseMetadataTypeDef

ExchangeCodeForTokenRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ExchangeCodeForTokenRequestRequestTypeDef

def get_value() -> ExchangeCodeForTokenRequestRequestTypeDef:
    return {
        "provider": ...,
        "request": ...,
    }

Definition

class ExchangeCodeForTokenRequestRequestTypeDef(TypedDict):
    provider: TokenProvidersType,  # (1)
    request: ExchangeCodeForTokenRequestBodyTypeDef,  # (2)

1. See TokenProvidersType
2. See ExchangeCodeForTokenRequestBodyTypeDef

ExportComponentsRequestExportComponentsPaginateTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ExportComponentsRequestExportComponentsPaginateTypeDef

def get_value() -> ExportComponentsRequestExportComponentsPaginateTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
    }

Definition

class ExportComponentsRequestExportComponentsPaginateTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ExportFormsRequestExportFormsPaginateTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ExportFormsRequestExportFormsPaginateTypeDef

def get_value() -> ExportFormsRequestExportFormsPaginateTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
    }

Definition

class ExportFormsRequestExportFormsPaginateTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ExportThemesRequestExportThemesPaginateTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ExportThemesRequestExportThemesPaginateTypeDef

def get_value() -> ExportThemesRequestExportThemesPaginateTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
    }

Definition

class ExportThemesRequestExportThemesPaginateTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListComponentsRequestListComponentsPaginateTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ListComponentsRequestListComponentsPaginateTypeDef

def get_value() -> ListComponentsRequestListComponentsPaginateTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
    }

Definition

class ListComponentsRequestListComponentsPaginateTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListFormsRequestListFormsPaginateTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ListFormsRequestListFormsPaginateTypeDef

def get_value() -> ListFormsRequestListFormsPaginateTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
    }

Definition

class ListFormsRequestListFormsPaginateTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListThemesRequestListThemesPaginateTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ListThemesRequestListThemesPaginateTypeDef

def get_value() -> ListThemesRequestListThemesPaginateTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
    }

Definition

class ListThemesRequestListThemesPaginateTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

FormButtonTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import FormButtonTypeDef

def get_value() -> FormButtonTypeDef:
    return {
        "children": ...,
    }

Definition

class FormButtonTypeDef(TypedDict):
    children: NotRequired[str],
    excluded: NotRequired[bool],
    position: NotRequired[FieldPositionTypeDef],  # (1)

1. See FieldPositionTypeDef

SectionalElementTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import SectionalElementTypeDef

def get_value() -> SectionalElementTypeDef:
    return {
        "type": ...,
    }

Definition

class SectionalElementTypeDef(TypedDict):
    type: str,
    level: NotRequired[int],
    orientation: NotRequired[str],
    position: NotRequired[FieldPositionTypeDef],  # (1)
    text: NotRequired[str],

1. See FieldPositionTypeDef

ValueMappingTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ValueMappingTypeDef

def get_value() -> ValueMappingTypeDef:
    return {
        "value": ...,
    }

Definition

class ValueMappingTypeDef(TypedDict):
    value: FormInputValuePropertyTypeDef,  # (1)
    displayValue: NotRequired[FormInputValuePropertyTypeDef],  # (1)

1. See FormInputValuePropertyTypeDef
2. See FormInputValuePropertyTypeDef

FormStyleTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import FormStyleTypeDef

def get_value() -> FormStyleTypeDef:
    return {
        "horizontalGap": ...,
    }

Definition

class FormStyleTypeDef(TypedDict):
    horizontalGap: NotRequired[FormStyleConfigTypeDef],  # (1)
    outerPadding: NotRequired[FormStyleConfigTypeDef],  # (1)
    verticalGap: NotRequired[FormStyleConfigTypeDef],  # (1)

1. See FormStyleConfigTypeDef
2. See FormStyleConfigTypeDef
3. See FormStyleConfigTypeDef

ListThemesResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ListThemesResponseTypeDef

def get_value() -> ListThemesResponseTypeDef:
    return {
        "entities": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListThemesResponseTypeDef(TypedDict):
    entities: List[ThemeSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ThemeSummaryTypeDef
2. See ResponseMetadataTypeDef

PutMetadataFlagRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import PutMetadataFlagRequestRequestTypeDef

def get_value() -> PutMetadataFlagRequestRequestTypeDef:
    return {
        "appId": ...,
        "body": ...,
        "environmentName": ...,
        "featureName": ...,
    }

Definition

class PutMetadataFlagRequestRequestTypeDef(TypedDict):
    appId: str,
    body: PutMetadataFlagBodyTypeDef,  # (1)
    environmentName: str,
    featureName: str,

1. See PutMetadataFlagBodyTypeDef

RefreshTokenRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import RefreshTokenRequestRequestTypeDef

def get_value() -> RefreshTokenRequestRequestTypeDef:
    return {
        "provider": ...,
        "refreshTokenBody": ...,
    }

Definition

class RefreshTokenRequestRequestTypeDef(TypedDict):
    provider: TokenProvidersType,  # (1)
    refreshTokenBody: RefreshTokenRequestBodyTypeDef,  # (2)

1. See TokenProvidersType
2. See RefreshTokenRequestBodyTypeDef

UpdateThemeRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateThemeRequestRequestTypeDef

def get_value() -> UpdateThemeRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
        "id": ...,
        "updatedTheme": ...,
    }

Definition

class UpdateThemeRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    id: str,
    updatedTheme: UpdateThemeDataTypeDef,  # (1)
    clientToken: NotRequired[str],

1. See UpdateThemeDataTypeDef

ComponentEventTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentEventTypeDef

def get_value() -> ComponentEventTypeDef:
    return {
        "action": ...,
    }

Definition

class ComponentEventTypeDef(TypedDict):
    action: NotRequired[str],
    bindingEvent: NotRequired[str],
    parameters: NotRequired[ActionParametersTypeDef],  # (1)

1. See ActionParametersTypeDef

ListFormsResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ListFormsResponseTypeDef

def get_value() -> ListFormsResponseTypeDef:
    return {
        "entities": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListFormsResponseTypeDef(TypedDict):
    entities: List[FormSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See FormSummaryTypeDef
2. See ResponseMetadataTypeDef

FormCTATypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import FormCTATypeDef

def get_value() -> FormCTATypeDef:
    return {
        "cancel": ...,
    }

Definition

class FormCTATypeDef(TypedDict):
    cancel: NotRequired[FormButtonTypeDef],  # (1)
    clear: NotRequired[FormButtonTypeDef],  # (1)
    position: NotRequired[FormButtonsPositionType],  # (3)
    submit: NotRequired[FormButtonTypeDef],  # (1)

1. See FormButtonTypeDef
2. See FormButtonTypeDef
3. See FormButtonsPositionType
4. See FormButtonTypeDef

ValueMappingsTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ValueMappingsTypeDef

def get_value() -> ValueMappingsTypeDef:
    return {
        "values": ...,
    }

Definition

class ValueMappingsTypeDef(TypedDict):
    values: Sequence[ValueMappingTypeDef],  # (1)

1. See ValueMappingTypeDef

ComponentChildTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentChildTypeDef

def get_value() -> ComponentChildTypeDef:
    return {
        "componentType": ...,
        "name": ...,
        "properties": ...,
    }

Definition

class ComponentChildTypeDef(TypedDict):
    componentType: str,
    name: str,
    properties: Mapping[str, ComponentPropertyTypeDef],  # (3)
    children: NotRequired[Sequence[ComponentChildTypeDef]],  # (1)
    events: NotRequired[Mapping[str, ComponentEventTypeDef]],  # (2)
    sourceId: NotRequired[str],

1. See ComponentChildTypeDef
2. See ComponentEventTypeDef
3. See ComponentPropertyTypeDef

ComponentTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentTypeDef

def get_value() -> ComponentTypeDef:
    return {
        "appId": ...,
        "bindingProperties": ...,
        "componentType": ...,
        "createdAt": ...,
        "environmentName": ...,
        "id": ...,
        "name": ...,
        "overrides": ...,
        "properties": ...,
        "variants": ...,
    }

Definition

class ComponentTypeDef(TypedDict):
    appId: str,
    bindingProperties: Dict[str, ComponentBindingPropertiesValueTypeDef],  # (1)
    componentType: str,
    createdAt: datetime,
    environmentName: str,
    id: str,
    name: str,
    overrides: Dict[str, Dict[str, str]],
    properties: Dict[str, ComponentPropertyTypeDef],  # (5)
    variants: List[ComponentVariantTypeDef],  # (6)
    children: NotRequired[List[ComponentChildTypeDef]],  # (2)
    collectionProperties: NotRequired[Dict[str, ComponentDataConfigurationTypeDef]],  # (3)
    events: NotRequired[Dict[str, ComponentEventTypeDef]],  # (4)
    modifiedAt: NotRequired[datetime],
    schemaVersion: NotRequired[str],
    sourceId: NotRequired[str],
    tags: NotRequired[Dict[str, str]],

1. See ComponentBindingPropertiesValueTypeDef
2. See ComponentChildTypeDef
3. See ComponentDataConfigurationTypeDef
4. See ComponentEventTypeDef
5. See ComponentPropertyTypeDef
6. See ComponentVariantTypeDef

CreateComponentDataTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import CreateComponentDataTypeDef

def get_value() -> CreateComponentDataTypeDef:
    return {
        "bindingProperties": ...,
        "componentType": ...,
        "name": ...,
        "overrides": ...,
        "properties": ...,
        "variants": ...,
    }

Definition

class CreateComponentDataTypeDef(TypedDict):
    bindingProperties: Mapping[str, ComponentBindingPropertiesValueTypeDef],  # (1)
    componentType: str,
    name: str,
    overrides: Mapping[str, Mapping[str, str]],
    properties: Mapping[str, ComponentPropertyTypeDef],  # (5)
    variants: Sequence[ComponentVariantTypeDef],  # (6)
    children: NotRequired[Sequence[ComponentChildTypeDef]],  # (2)
    collectionProperties: NotRequired[Mapping[str, ComponentDataConfigurationTypeDef]],  # (3)
    events: NotRequired[Mapping[str, ComponentEventTypeDef]],  # (4)
    schemaVersion: NotRequired[str],
    sourceId: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

1. See ComponentBindingPropertiesValueTypeDef
2. See ComponentChildTypeDef
3. See ComponentDataConfigurationTypeDef
4. See ComponentEventTypeDef
5. See ComponentPropertyTypeDef
6. See ComponentVariantTypeDef

UpdateComponentDataTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateComponentDataTypeDef

def get_value() -> UpdateComponentDataTypeDef:
    return {
        "bindingProperties": ...,
    }

Definition

class UpdateComponentDataTypeDef(TypedDict):
    bindingProperties: NotRequired[Mapping[str, ComponentBindingPropertiesValueTypeDef]],  # (1)
    children: NotRequired[Sequence[ComponentChildTypeDef]],  # (2)
    collectionProperties: NotRequired[Mapping[str, ComponentDataConfigurationTypeDef]],  # (3)
    componentType: NotRequired[str],
    events: NotRequired[Mapping[str, ComponentEventTypeDef]],  # (4)
    id: NotRequired[str],
    name: NotRequired[str],
    overrides: NotRequired[Mapping[str, Mapping[str, str]]],
    properties: NotRequired[Mapping[str, ComponentPropertyTypeDef]],  # (5)
    schemaVersion: NotRequired[str],
    sourceId: NotRequired[str],
    variants: NotRequired[Sequence[ComponentVariantTypeDef]],  # (6)

1. See ComponentBindingPropertiesValueTypeDef
2. See ComponentChildTypeDef
3. See ComponentDataConfigurationTypeDef
4. See ComponentEventTypeDef
5. See ComponentPropertyTypeDef
6. See ComponentVariantTypeDef

FieldInputConfigTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import FieldInputConfigTypeDef

def get_value() -> FieldInputConfigTypeDef:
    return {
        "type": ...,
    }

Definition

class FieldInputConfigTypeDef(TypedDict):
    type: str,
    defaultChecked: NotRequired[bool],
    defaultCountryCode: NotRequired[str],
    defaultValue: NotRequired[str],
    descriptiveText: NotRequired[str],
    isArray: NotRequired[bool],
    maxValue: NotRequired[float],
    minValue: NotRequired[float],
    name: NotRequired[str],
    placeholder: NotRequired[str],
    readOnly: NotRequired[bool],
    required: NotRequired[bool],
    step: NotRequired[float],
    value: NotRequired[str],
    valueMappings: NotRequired[ValueMappingsTypeDef],  # (1)

1. See ValueMappingsTypeDef

CreateComponentResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import CreateComponentResponseTypeDef

def get_value() -> CreateComponentResponseTypeDef:
    return {
        "entity": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateComponentResponseTypeDef(TypedDict):
    entity: ComponentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComponentTypeDef
2. See ResponseMetadataTypeDef

ExportComponentsResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ExportComponentsResponseTypeDef

def get_value() -> ExportComponentsResponseTypeDef:
    return {
        "entities": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ExportComponentsResponseTypeDef(TypedDict):
    entities: List[ComponentTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComponentTypeDef
2. See ResponseMetadataTypeDef

GetComponentResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import GetComponentResponseTypeDef

def get_value() -> GetComponentResponseTypeDef:
    return {
        "component": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetComponentResponseTypeDef(TypedDict):
    component: ComponentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComponentTypeDef
2. See ResponseMetadataTypeDef

UpdateComponentResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateComponentResponseTypeDef

def get_value() -> UpdateComponentResponseTypeDef:
    return {
        "entity": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateComponentResponseTypeDef(TypedDict):
    entity: ComponentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ComponentTypeDef
2. See ResponseMetadataTypeDef

CreateComponentRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import CreateComponentRequestRequestTypeDef

def get_value() -> CreateComponentRequestRequestTypeDef:
    return {
        "appId": ...,
        "componentToCreate": ...,
        "environmentName": ...,
    }

Definition

class CreateComponentRequestRequestTypeDef(TypedDict):
    appId: str,
    componentToCreate: CreateComponentDataTypeDef,  # (1)
    environmentName: str,
    clientToken: NotRequired[str],

1. See CreateComponentDataTypeDef

UpdateComponentRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateComponentRequestRequestTypeDef

def get_value() -> UpdateComponentRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
        "id": ...,
        "updatedComponent": ...,
    }

Definition

class UpdateComponentRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    id: str,
    updatedComponent: UpdateComponentDataTypeDef,  # (1)
    clientToken: NotRequired[str],

1. See UpdateComponentDataTypeDef

FieldConfigTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import FieldConfigTypeDef

def get_value() -> FieldConfigTypeDef:
    return {
        "excluded": ...,
    }

Definition

class FieldConfigTypeDef(TypedDict):
    excluded: NotRequired[bool],
    inputType: NotRequired[FieldInputConfigTypeDef],  # (1)
    label: NotRequired[str],
    position: NotRequired[FieldPositionTypeDef],  # (2)
    validations: NotRequired[Sequence[FieldValidationConfigurationTypeDef]],  # (3)

1. See FieldInputConfigTypeDef
2. See FieldPositionTypeDef
3. See FieldValidationConfigurationTypeDef

CreateFormDataTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import CreateFormDataTypeDef

def get_value() -> CreateFormDataTypeDef:
    return {
        "dataType": ...,
        "fields": ...,
        "formActionType": ...,
        "name": ...,
        "schemaVersion": ...,
        "sectionalElements": ...,
        "style": ...,
    }

Definition

class CreateFormDataTypeDef(TypedDict):
    dataType: FormDataTypeConfigTypeDef,  # (2)
    fields: Mapping[str, FieldConfigTypeDef],  # (3)
    formActionType: FormActionTypeType,  # (4)
    name: str,
    schemaVersion: str,
    sectionalElements: Mapping[str, SectionalElementTypeDef],  # (5)
    style: FormStyleTypeDef,  # (6)
    cta: NotRequired[FormCTATypeDef],  # (1)
    tags: NotRequired[Mapping[str, str]],

1. See FormCTATypeDef
2. See FormDataTypeConfigTypeDef
3. See FieldConfigTypeDef
4. See FormActionTypeType
5. See SectionalElementTypeDef
6. See FormStyleTypeDef

FormTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import FormTypeDef

def get_value() -> FormTypeDef:
    return {
        "appId": ...,
        "dataType": ...,
        "environmentName": ...,
        "fields": ...,
        "formActionType": ...,
        "id": ...,
        "name": ...,
        "schemaVersion": ...,
        "sectionalElements": ...,
        "style": ...,
    }

Definition

class FormTypeDef(TypedDict):
    appId: str,
    dataType: FormDataTypeConfigTypeDef,  # (2)
    environmentName: str,
    fields: Dict[str, FieldConfigTypeDef],  # (3)
    formActionType: FormActionTypeType,  # (4)
    id: str,
    name: str,
    schemaVersion: str,
    sectionalElements: Dict[str, SectionalElementTypeDef],  # (5)
    style: FormStyleTypeDef,  # (6)
    cta: NotRequired[FormCTATypeDef],  # (1)
    tags: NotRequired[Dict[str, str]],

1. See FormCTATypeDef
2. See FormDataTypeConfigTypeDef
3. See FieldConfigTypeDef
4. See FormActionTypeType
5. See SectionalElementTypeDef
6. See FormStyleTypeDef

UpdateFormDataTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateFormDataTypeDef

def get_value() -> UpdateFormDataTypeDef:
    return {
        "cta": ...,
    }

Definition

class UpdateFormDataTypeDef(TypedDict):
    cta: NotRequired[FormCTATypeDef],  # (1)
    dataType: NotRequired[FormDataTypeConfigTypeDef],  # (2)
    fields: NotRequired[Mapping[str, FieldConfigTypeDef]],  # (3)
    formActionType: NotRequired[FormActionTypeType],  # (4)
    name: NotRequired[str],
    schemaVersion: NotRequired[str],
    sectionalElements: NotRequired[Mapping[str, SectionalElementTypeDef]],  # (5)
    style: NotRequired[FormStyleTypeDef],  # (6)

1. See FormCTATypeDef
2. See FormDataTypeConfigTypeDef
3. See FieldConfigTypeDef
4. See FormActionTypeType
5. See SectionalElementTypeDef
6. See FormStyleTypeDef

CreateFormRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import CreateFormRequestRequestTypeDef

def get_value() -> CreateFormRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
        "formToCreate": ...,
    }

Definition

class CreateFormRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    formToCreate: CreateFormDataTypeDef,  # (1)
    clientToken: NotRequired[str],

1. See CreateFormDataTypeDef

CreateFormResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import CreateFormResponseTypeDef

def get_value() -> CreateFormResponseTypeDef:
    return {
        "entity": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateFormResponseTypeDef(TypedDict):
    entity: FormTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See FormTypeDef
2. See ResponseMetadataTypeDef

ExportFormsResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import ExportFormsResponseTypeDef

def get_value() -> ExportFormsResponseTypeDef:
    return {
        "entities": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ExportFormsResponseTypeDef(TypedDict):
    entities: List[FormTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See FormTypeDef
2. See ResponseMetadataTypeDef

GetFormResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import GetFormResponseTypeDef

def get_value() -> GetFormResponseTypeDef:
    return {
        "form": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetFormResponseTypeDef(TypedDict):
    form: FormTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See FormTypeDef
2. See ResponseMetadataTypeDef

UpdateFormResponseTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateFormResponseTypeDef

def get_value() -> UpdateFormResponseTypeDef:
    return {
        "entity": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateFormResponseTypeDef(TypedDict):
    entity: FormTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See FormTypeDef
2. See ResponseMetadataTypeDef

UpdateFormRequestRequestTypeDef

Usage Example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateFormRequestRequestTypeDef

def get_value() -> UpdateFormRequestRequestTypeDef:
    return {
        "appId": ...,
        "environmentName": ...,
        "id": ...,
        "updatedForm": ...,
    }

Definition

class UpdateFormRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    id: str,
    updatedForm: UpdateFormDataTypeDef,  # (1)
    clientToken: NotRequired[str],

1. See UpdateFormDataTypeDef