Skip to content

Typed dictionaries#

Index > AmplifyUIBuilder > Typed dictionaries

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

ActionParametersTypeDef#

# ActionParametersTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ActionParametersTypeDef

def get_value() -> ActionParametersTypeDef:
    return {
        "type": ...,
    }
# ActionParametersTypeDef definition

class ActionParametersTypeDef(TypedDict):
    type: NotRequired[ComponentPropertyTypeDef],  # (1)
    url: NotRequired[ComponentPropertyTypeDef],  # (1)
    anchor: NotRequired[ComponentPropertyTypeDef],  # (1)
    target: NotRequired[ComponentPropertyTypeDef],  # (1)
    global: NotRequired[ComponentPropertyTypeDef],  # (1)
    model: NotRequired[str],
    id: NotRequired[ComponentPropertyTypeDef],  # (1)
    fields: NotRequired[Mapping[str, ComponentPropertyTypeDef]],  # (7)
    state: NotRequired[MutationActionSetStateParameterTypeDef],  # (8)
  1. See ComponentPropertyTypeDef
  2. See ComponentPropertyTypeDef
  3. See ComponentPropertyTypeDef
  4. See ComponentPropertyTypeDef
  5. See ComponentPropertyTypeDef
  6. See ComponentPropertyTypeDef
  7. See ComponentPropertyTypeDef
  8. See MutationActionSetStateParameterTypeDef

ComponentBindingPropertiesValuePropertiesTypeDef#

# ComponentBindingPropertiesValuePropertiesTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentBindingPropertiesValuePropertiesTypeDef

def get_value() -> ComponentBindingPropertiesValuePropertiesTypeDef:
    return {
        "model": ...,
    }
# ComponentBindingPropertiesValuePropertiesTypeDef definition

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

ComponentBindingPropertiesValueTypeDef#

# ComponentBindingPropertiesValueTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentBindingPropertiesValueTypeDef

def get_value() -> ComponentBindingPropertiesValueTypeDef:
    return {
        "type": ...,
    }
# ComponentBindingPropertiesValueTypeDef definition

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

ComponentChildTypeDef#

# ComponentChildTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentChildTypeDef

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

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

ComponentConditionPropertyTypeDef#

# ComponentConditionPropertyTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentConditionPropertyTypeDef

def get_value() -> ComponentConditionPropertyTypeDef:
    return {
        "property": ...,
    }
# ComponentConditionPropertyTypeDef definition

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

ComponentDataConfigurationTypeDef#

# ComponentDataConfigurationTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentDataConfigurationTypeDef

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

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

ComponentEventTypeDef#

# ComponentEventTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentEventTypeDef

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

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

ComponentPropertyBindingPropertiesTypeDef#

# ComponentPropertyBindingPropertiesTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentPropertyBindingPropertiesTypeDef

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

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

ComponentPropertyTypeDef#

# ComponentPropertyTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentPropertyTypeDef

def get_value() -> ComponentPropertyTypeDef:
    return {
        "value": ...,
    }
# ComponentPropertyTypeDef definition

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

ComponentSummaryTypeDef#

# ComponentSummaryTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentSummaryTypeDef

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

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

ComponentTypeDef#

# ComponentTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentTypeDef

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

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

ComponentVariantTypeDef#

# ComponentVariantTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ComponentVariantTypeDef

def get_value() -> ComponentVariantTypeDef:
    return {
        "variantValues": ...,
    }
# ComponentVariantTypeDef definition

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

CreateComponentDataTypeDef#

# CreateComponentDataTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import CreateComponentDataTypeDef

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

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

CreateComponentRequestRequestTypeDef#

# CreateComponentRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import CreateComponentRequestRequestTypeDef

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

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

CreateComponentResponseTypeDef#

# CreateComponentResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import CreateComponentResponseTypeDef

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

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

CreateFormDataTypeDef#

# CreateFormDataTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import CreateFormDataTypeDef

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

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

CreateFormRequestRequestTypeDef#

# CreateFormRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import CreateFormRequestRequestTypeDef

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

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

CreateFormResponseTypeDef#

# CreateFormResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import CreateFormResponseTypeDef

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

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

CreateThemeDataTypeDef#

# CreateThemeDataTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import CreateThemeDataTypeDef

def get_value() -> CreateThemeDataTypeDef:
    return {
        "name": ...,
        "values": ...,
    }
# CreateThemeDataTypeDef 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

CreateThemeRequestRequestTypeDef#

# CreateThemeRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import CreateThemeRequestRequestTypeDef

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

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

CreateThemeResponseTypeDef#

# CreateThemeResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import CreateThemeResponseTypeDef

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

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

DeleteComponentRequestRequestTypeDef#

# DeleteComponentRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import DeleteComponentRequestRequestTypeDef

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

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

DeleteFormRequestRequestTypeDef#

# DeleteFormRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import DeleteFormRequestRequestTypeDef

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

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

DeleteThemeRequestRequestTypeDef#

# DeleteThemeRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import DeleteThemeRequestRequestTypeDef

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

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import EmptyResponseMetadataTypeDef

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

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

ExchangeCodeForTokenRequestBodyTypeDef#

# ExchangeCodeForTokenRequestBodyTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ExchangeCodeForTokenRequestBodyTypeDef

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

class ExchangeCodeForTokenRequestBodyTypeDef(TypedDict):
    code: str,
    redirectUri: str,
    clientId: NotRequired[str],

ExchangeCodeForTokenRequestRequestTypeDef#

# ExchangeCodeForTokenRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ExchangeCodeForTokenRequestRequestTypeDef

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

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

ExchangeCodeForTokenResponseTypeDef#

# ExchangeCodeForTokenResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ExchangeCodeForTokenResponseTypeDef

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

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

ExportComponentsRequestExportComponentsPaginateTypeDef#

# ExportComponentsRequestExportComponentsPaginateTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ExportComponentsRequestExportComponentsPaginateTypeDef

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

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

ExportComponentsRequestRequestTypeDef#

# ExportComponentsRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ExportComponentsRequestRequestTypeDef

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

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

ExportComponentsResponseTypeDef#

# ExportComponentsResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ExportComponentsResponseTypeDef

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

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

ExportFormsRequestExportFormsPaginateTypeDef#

# ExportFormsRequestExportFormsPaginateTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ExportFormsRequestExportFormsPaginateTypeDef

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

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

ExportFormsRequestRequestTypeDef#

# ExportFormsRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ExportFormsRequestRequestTypeDef

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

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

ExportFormsResponseTypeDef#

# ExportFormsResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ExportFormsResponseTypeDef

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

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

ExportThemesRequestExportThemesPaginateTypeDef#

# ExportThemesRequestExportThemesPaginateTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ExportThemesRequestExportThemesPaginateTypeDef

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

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

ExportThemesRequestRequestTypeDef#

# ExportThemesRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ExportThemesRequestRequestTypeDef

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

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

ExportThemesResponseTypeDef#

# ExportThemesResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ExportThemesResponseTypeDef

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

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

FieldConfigTypeDef#

# FieldConfigTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FieldConfigTypeDef

def get_value() -> FieldConfigTypeDef:
    return {
        "label": ...,
    }
# FieldConfigTypeDef definition

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

FieldInputConfigTypeDef#

# FieldInputConfigTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FieldInputConfigTypeDef

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

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

FieldPositionTypeDef#

# FieldPositionTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FieldPositionTypeDef

def get_value() -> FieldPositionTypeDef:
    return {
        "fixed": ...,
    }
# FieldPositionTypeDef definition

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

FieldValidationConfigurationTypeDef#

# FieldValidationConfigurationTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FieldValidationConfigurationTypeDef

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

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

FileUploaderFieldConfigTypeDef#

# FileUploaderFieldConfigTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FileUploaderFieldConfigTypeDef

def get_value() -> FileUploaderFieldConfigTypeDef:
    return {
        "accessLevel": ...,
        "acceptedFileTypes": ...,
    }
# FileUploaderFieldConfigTypeDef definition

class FileUploaderFieldConfigTypeDef(TypedDict):
    accessLevel: StorageAccessLevelType,  # (1)
    acceptedFileTypes: Sequence[str],
    showThumbnails: NotRequired[bool],
    isResumable: NotRequired[bool],
    maxFileCount: NotRequired[int],
    maxSize: NotRequired[int],
  1. See StorageAccessLevelType

FormBindingElementTypeDef#

# FormBindingElementTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FormBindingElementTypeDef

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

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

FormButtonTypeDef#

# FormButtonTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FormButtonTypeDef

def get_value() -> FormButtonTypeDef:
    return {
        "excluded": ...,
    }
# FormButtonTypeDef definition

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

FormCTATypeDef#

# FormCTATypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FormCTATypeDef

def get_value() -> FormCTATypeDef:
    return {
        "position": ...,
    }
# FormCTATypeDef definition

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

FormDataTypeConfigTypeDef#

# FormDataTypeConfigTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FormDataTypeConfigTypeDef

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

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

FormInputBindingPropertiesValuePropertiesTypeDef#

# FormInputBindingPropertiesValuePropertiesTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FormInputBindingPropertiesValuePropertiesTypeDef

def get_value() -> FormInputBindingPropertiesValuePropertiesTypeDef:
    return {
        "model": ...,
    }
# FormInputBindingPropertiesValuePropertiesTypeDef definition

class FormInputBindingPropertiesValuePropertiesTypeDef(TypedDict):
    model: NotRequired[str],

FormInputBindingPropertiesValueTypeDef#

# FormInputBindingPropertiesValueTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FormInputBindingPropertiesValueTypeDef

def get_value() -> FormInputBindingPropertiesValueTypeDef:
    return {
        "type": ...,
    }
# FormInputBindingPropertiesValueTypeDef definition

class FormInputBindingPropertiesValueTypeDef(TypedDict):
    type: NotRequired[str],
    bindingProperties: NotRequired[FormInputBindingPropertiesValuePropertiesTypeDef],  # (1)
  1. See FormInputBindingPropertiesValuePropertiesTypeDef

FormInputValuePropertyBindingPropertiesTypeDef#

# FormInputValuePropertyBindingPropertiesTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FormInputValuePropertyBindingPropertiesTypeDef

def get_value() -> FormInputValuePropertyBindingPropertiesTypeDef:
    return {
        "property": ...,
    }
# FormInputValuePropertyBindingPropertiesTypeDef definition

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

FormInputValuePropertyTypeDef#

# FormInputValuePropertyTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FormInputValuePropertyTypeDef

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

class FormInputValuePropertyTypeDef(TypedDict):
    value: NotRequired[str],
    bindingProperties: NotRequired[FormInputValuePropertyBindingPropertiesTypeDef],  # (1)
    concat: NotRequired[Sequence[FormInputValuePropertyTypeDef]],  # (2)
  1. See FormInputValuePropertyBindingPropertiesTypeDef
  2. See FormInputValuePropertyTypeDef

FormStyleConfigTypeDef#

# FormStyleConfigTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FormStyleConfigTypeDef

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

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

FormStyleTypeDef#

# FormStyleTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FormStyleTypeDef

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

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

FormSummaryTypeDef#

# FormSummaryTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FormSummaryTypeDef

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

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

FormTypeDef#

# FormTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import FormTypeDef

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

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

GetComponentRequestRequestTypeDef#

# GetComponentRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import GetComponentRequestRequestTypeDef

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

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

GetComponentResponseTypeDef#

# GetComponentResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import GetComponentResponseTypeDef

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

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

GetFormRequestRequestTypeDef#

# GetFormRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import GetFormRequestRequestTypeDef

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

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

GetFormResponseTypeDef#

# GetFormResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import GetFormResponseTypeDef

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

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

GetMetadataRequestRequestTypeDef#

# GetMetadataRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import GetMetadataRequestRequestTypeDef

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

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

GetMetadataResponseTypeDef#

# GetMetadataResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import GetMetadataResponseTypeDef

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

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

GetThemeRequestRequestTypeDef#

# GetThemeRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import GetThemeRequestRequestTypeDef

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

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

GetThemeResponseTypeDef#

# GetThemeResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import GetThemeResponseTypeDef

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

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

ListComponentsRequestListComponentsPaginateTypeDef#

# ListComponentsRequestListComponentsPaginateTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ListComponentsRequestListComponentsPaginateTypeDef

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

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

ListComponentsRequestRequestTypeDef#

# ListComponentsRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ListComponentsRequestRequestTypeDef

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

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

ListComponentsResponseTypeDef#

# ListComponentsResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ListComponentsResponseTypeDef

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

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

ListFormsRequestListFormsPaginateTypeDef#

# ListFormsRequestListFormsPaginateTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ListFormsRequestListFormsPaginateTypeDef

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

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

ListFormsRequestRequestTypeDef#

# ListFormsRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ListFormsRequestRequestTypeDef

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

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

ListFormsResponseTypeDef#

# ListFormsResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ListFormsResponseTypeDef

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

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

ListThemesRequestListThemesPaginateTypeDef#

# ListThemesRequestListThemesPaginateTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ListThemesRequestListThemesPaginateTypeDef

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

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

ListThemesRequestRequestTypeDef#

# ListThemesRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ListThemesRequestRequestTypeDef

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

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

ListThemesResponseTypeDef#

# ListThemesResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ListThemesResponseTypeDef

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

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

MutationActionSetStateParameterTypeDef#

# MutationActionSetStateParameterTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import MutationActionSetStateParameterTypeDef

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

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import PaginatorConfigTypeDef

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

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

PredicateTypeDef#

# PredicateTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import PredicateTypeDef

def get_value() -> PredicateTypeDef:
    return {
        "or": ...,
    }
# PredicateTypeDef definition

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

PutMetadataFlagBodyTypeDef#

# PutMetadataFlagBodyTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import PutMetadataFlagBodyTypeDef

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

class PutMetadataFlagBodyTypeDef(TypedDict):
    newValue: str,

PutMetadataFlagRequestRequestTypeDef#

# PutMetadataFlagRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import PutMetadataFlagRequestRequestTypeDef

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

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

RefreshTokenRequestBodyTypeDef#

# RefreshTokenRequestBodyTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import RefreshTokenRequestBodyTypeDef

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

class RefreshTokenRequestBodyTypeDef(TypedDict):
    token: str,
    clientId: NotRequired[str],

RefreshTokenRequestRequestTypeDef#

# RefreshTokenRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import RefreshTokenRequestRequestTypeDef

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

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

RefreshTokenResponseTypeDef#

# RefreshTokenResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import RefreshTokenResponseTypeDef

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

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ResponseMetadataTypeDef

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

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

SectionalElementTypeDef#

# SectionalElementTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import SectionalElementTypeDef

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

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

SortPropertyTypeDef#

# SortPropertyTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import SortPropertyTypeDef

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

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

ThemeSummaryTypeDef#

# ThemeSummaryTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ThemeSummaryTypeDef

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

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

ThemeTypeDef#

# ThemeTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ThemeTypeDef

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

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

ThemeValueTypeDef#

# ThemeValueTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ThemeValueTypeDef

def get_value() -> ThemeValueTypeDef:
    return {
        "value": ...,
    }
# ThemeValueTypeDef definition

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

ThemeValuesTypeDef#

# ThemeValuesTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ThemeValuesTypeDef

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

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

UpdateComponentDataTypeDef#

# UpdateComponentDataTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateComponentDataTypeDef

def get_value() -> UpdateComponentDataTypeDef:
    return {
        "id": ...,
    }
# UpdateComponentDataTypeDef definition

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

UpdateComponentRequestRequestTypeDef#

# UpdateComponentRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateComponentRequestRequestTypeDef

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

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

UpdateComponentResponseTypeDef#

# UpdateComponentResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateComponentResponseTypeDef

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

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

UpdateFormDataTypeDef#

# UpdateFormDataTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateFormDataTypeDef

def get_value() -> UpdateFormDataTypeDef:
    return {
        "name": ...,
    }
# UpdateFormDataTypeDef definition

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

UpdateFormRequestRequestTypeDef#

# UpdateFormRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateFormRequestRequestTypeDef

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

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

UpdateFormResponseTypeDef#

# UpdateFormResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateFormResponseTypeDef

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

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

UpdateThemeDataTypeDef#

# UpdateThemeDataTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateThemeDataTypeDef

def get_value() -> UpdateThemeDataTypeDef:
    return {
        "values": ...,
    }
# UpdateThemeDataTypeDef 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

UpdateThemeRequestRequestTypeDef#

# UpdateThemeRequestRequestTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateThemeRequestRequestTypeDef

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

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

UpdateThemeResponseTypeDef#

# UpdateThemeResponseTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import UpdateThemeResponseTypeDef

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

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

ValueMappingTypeDef#

# ValueMappingTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ValueMappingTypeDef

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

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

ValueMappingsTypeDef#

# ValueMappingsTypeDef usage example

from mypy_boto3_amplifyuibuilder.type_defs import ValueMappingsTypeDef

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

class ValueMappingsTypeDef(TypedDict):
    values: Sequence[ValueMappingTypeDef],  # (1)
    bindingProperties: NotRequired[Mapping[str, FormInputBindingPropertiesValueTypeDef]],  # (2)
  1. See ValueMappingTypeDef
  2. See FormInputBindingPropertiesValueTypeDef