Skip to content

Type definitions#

Index > AmplifyUIBuilder > Type definitions

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

MutationActionSetStateParameterPaginatorTypeDef#

# MutationActionSetStateParameterPaginatorTypeDef definition

class MutationActionSetStateParameterPaginatorTypeDef(TypedDict):
    componentName: str,
    property: str,
    set: ComponentPropertyPaginatorTypeDef,  # (1)
  1. See ComponentPropertyPaginatorTypeDef

MutationActionSetStateParameterTypeDef#

# MutationActionSetStateParameterTypeDef definition

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

GraphQLRenderConfigTypeDef#

# GraphQLRenderConfigTypeDef definition

class GraphQLRenderConfigTypeDef(TypedDict):
    typesFilePath: str,
    queriesFilePath: str,
    mutationsFilePath: str,
    subscriptionsFilePath: str,
    fragmentsFilePath: str,

CodegenDependencyTypeDef#

# CodegenDependencyTypeDef definition

class CodegenDependencyTypeDef(TypedDict):
    name: NotRequired[str],
    supportedVersion: NotRequired[str],
    isSemVer: NotRequired[bool],
    reason: NotRequired[str],

CodegenFeatureFlagsTypeDef#

# CodegenFeatureFlagsTypeDef definition

class CodegenFeatureFlagsTypeDef(TypedDict):
    isRelationshipSupported: NotRequired[bool],
    isNonModelSupported: NotRequired[bool],

CodegenGenericDataEnumTypeDef#

# CodegenGenericDataEnumTypeDef definition

class CodegenGenericDataEnumTypeDef(TypedDict):
    values: List[str],

CodegenGenericDataRelationshipTypeTypeDef#

# CodegenGenericDataRelationshipTypeTypeDef definition

class CodegenGenericDataRelationshipTypeTypeDef(TypedDict):
    type: GenericDataRelationshipTypeType,  # (1)
    relatedModelName: str,
    relatedModelFields: NotRequired[List[str]],
    canUnlinkAssociatedModel: NotRequired[bool],
    relatedJoinFieldName: NotRequired[str],
    relatedJoinTableName: NotRequired[str],
    belongsToFieldOnRelatedModel: NotRequired[str],
    associatedFields: NotRequired[List[str]],
    isHasManyIndex: NotRequired[bool],
  1. See GenericDataRelationshipTypeType

CodegenJobAssetTypeDef#

# CodegenJobAssetTypeDef definition

class CodegenJobAssetTypeDef(TypedDict):
    downloadUrl: NotRequired[str],

CodegenJobSummaryTypeDef#

# CodegenJobSummaryTypeDef definition

class CodegenJobSummaryTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    id: str,
    createdAt: NotRequired[datetime],
    modifiedAt: NotRequired[datetime],

ComponentBindingPropertiesValuePropertiesPaginatorTypeDef#

# ComponentBindingPropertiesValuePropertiesPaginatorTypeDef definition

class ComponentBindingPropertiesValuePropertiesPaginatorTypeDef(TypedDict):
    model: NotRequired[str],
    field: NotRequired[str],
    predicates: NotRequired[List[PredicatePaginatorTypeDef]],  # (1)
    userAttribute: NotRequired[str],
    bucket: NotRequired[str],
    key: NotRequired[str],
    defaultValue: NotRequired[str],
    slotName: NotRequired[str],
  1. See PredicatePaginatorTypeDef

ComponentBindingPropertiesValuePropertiesTypeDef#

# 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

ComponentConditionPropertyTypeDef#

# 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

SortPropertyTypeDef#

# SortPropertyTypeDef definition

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

ComponentVariantPaginatorTypeDef#

# ComponentVariantPaginatorTypeDef definition

class ComponentVariantPaginatorTypeDef(TypedDict):
    variantValues: NotRequired[Dict[str, str]],
    overrides: NotRequired[Dict[str, Dict[str, str]]],

ComponentPropertyBindingPropertiesTypeDef#

# ComponentPropertyBindingPropertiesTypeDef definition

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

FormBindingElementTypeDef#

# FormBindingElementTypeDef definition

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

ComponentSummaryTypeDef#

# ComponentSummaryTypeDef definition

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

ComponentVariantTypeDef#

# ComponentVariantTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

FormDataTypeConfigTypeDef#

# FormDataTypeConfigTypeDef definition

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

CreateThemeDataTypeDef#

# 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

ThemeTypeDef#

# 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

DeleteComponentRequestRequestTypeDef#

# DeleteComponentRequestRequestTypeDef definition

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

DeleteFormRequestRequestTypeDef#

# DeleteFormRequestRequestTypeDef definition

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

DeleteThemeRequestRequestTypeDef#

# DeleteThemeRequestRequestTypeDef definition

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

ExchangeCodeForTokenRequestBodyTypeDef#

# ExchangeCodeForTokenRequestBodyTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ExportComponentsRequestRequestTypeDef