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#

# ExportComponentsRequestRequestTypeDef definition

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

ExportFormsRequestRequestTypeDef#

# ExportFormsRequestRequestTypeDef definition

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

ExportThemesRequestRequestTypeDef#

# ExportThemesRequestRequestTypeDef definition

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

ThemePaginatorTypeDef#

# ThemePaginatorTypeDef definition

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

FieldPositionTypeDef#

# FieldPositionTypeDef definition

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

FieldValidationConfigurationPaginatorTypeDef#

# FieldValidationConfigurationPaginatorTypeDef definition

class FieldValidationConfigurationPaginatorTypeDef(TypedDict):
    type: str,
    strValues: NotRequired[List[str]],
    numValues: NotRequired[List[int]],
    validationMessage: NotRequired[str],

FieldValidationConfigurationTypeDef#

# FieldValidationConfigurationTypeDef definition

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

FileUploaderFieldConfigPaginatorTypeDef#

# FileUploaderFieldConfigPaginatorTypeDef definition

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

FileUploaderFieldConfigTypeDef#

# 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

FormInputBindingPropertiesValuePropertiesTypeDef#

# FormInputBindingPropertiesValuePropertiesTypeDef definition

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

FormInputValuePropertyBindingPropertiesTypeDef#

# FormInputValuePropertyBindingPropertiesTypeDef definition

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

FormStyleConfigTypeDef#

# FormStyleConfigTypeDef definition

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

GetCodegenJobRequestRequestTypeDef#

# GetCodegenJobRequestRequestTypeDef definition

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

GetComponentRequestRequestTypeDef#

# GetComponentRequestRequestTypeDef definition

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

GetFormRequestRequestTypeDef#

# GetFormRequestRequestTypeDef definition

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

GetMetadataRequestRequestTypeDef#

# GetMetadataRequestRequestTypeDef definition

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

GetThemeRequestRequestTypeDef#

# GetThemeRequestRequestTypeDef definition

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

ListCodegenJobsRequestRequestTypeDef#

# ListCodegenJobsRequestRequestTypeDef definition

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

ListComponentsRequestRequestTypeDef#

# ListComponentsRequestRequestTypeDef definition

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

ListFormsRequestRequestTypeDef#

# ListFormsRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListThemesRequestRequestTypeDef#

# ListThemesRequestRequestTypeDef definition

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

ThemeSummaryTypeDef#

# ThemeSummaryTypeDef definition

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

PredicatePaginatorTypeDef#

# PredicatePaginatorTypeDef definition

class PredicatePaginatorTypeDef(TypedDict):
    or: NotRequired[List[Dict[str, Any]]],
    and: NotRequired[List[Dict[str, Any]]],
    field: NotRequired[str],
    operator: NotRequired[str],
    operand: NotRequired[str],
    operandType: NotRequired[str],

PredicateTypeDef#

# PredicateTypeDef definition

class PredicateTypeDef(TypedDict):
    or: NotRequired[Sequence[Dict[str, Any]]],
    and: NotRequired[Sequence[Dict[str, Any]]],
    field: NotRequired[str],
    operator: NotRequired[str],
    operand: NotRequired[str],
    operandType: NotRequired[str],

PutMetadataFlagBodyTypeDef#

# PutMetadataFlagBodyTypeDef definition

class PutMetadataFlagBodyTypeDef(TypedDict):
    newValue: str,

RefreshTokenRequestBodyTypeDef#

# RefreshTokenRequestBodyTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

ThemeValuePaginatorTypeDef#

# ThemeValuePaginatorTypeDef definition

class ThemeValuePaginatorTypeDef(TypedDict):
    value: NotRequired[str],
    children: NotRequired[List[ThemeValuesPaginatorTypeDef]],  # (1)
  1. See ThemeValuesPaginatorTypeDef

ThemeValueTypeDef#

# ThemeValueTypeDef definition

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

ThemeValuesPaginatorTypeDef#

# ThemeValuesPaginatorTypeDef definition

class ThemeValuesPaginatorTypeDef(TypedDict):
    key: NotRequired[str],
    value: NotRequired[Dict[str, Any]],

ThemeValuesTypeDef#

# ThemeValuesTypeDef definition

class ThemeValuesTypeDef(TypedDict):
    key: NotRequired[str],
    value: NotRequired[Dict[str, Any]],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateThemeDataTypeDef#

# 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

ValueMappingPaginatorTypeDef#

# ValueMappingPaginatorTypeDef definition

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

ValueMappingTypeDef#

# ValueMappingTypeDef definition

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

ActionParametersPaginatorTypeDef#

# ActionParametersPaginatorTypeDef definition

class ActionParametersPaginatorTypeDef(TypedDict):
    type: NotRequired[ComponentPropertyPaginatorTypeDef],  # (1)
    url: NotRequired[ComponentPropertyPaginatorTypeDef],  # (1)
    anchor: NotRequired[ComponentPropertyPaginatorTypeDef],  # (1)
    target: NotRequired[ComponentPropertyPaginatorTypeDef],  # (1)
    global: NotRequired[ComponentPropertyPaginatorTypeDef],  # (1)
    model: NotRequired[str],
    id: NotRequired[ComponentPropertyPaginatorTypeDef],  # (1)
    fields: NotRequired[Dict[str, ComponentPropertyPaginatorTypeDef]],  # (7)
    state: NotRequired[MutationActionSetStateParameterPaginatorTypeDef],  # (8)
  1. See ComponentPropertyPaginatorTypeDef
  2. See ComponentPropertyPaginatorTypeDef
  3. See ComponentPropertyPaginatorTypeDef
  4. See ComponentPropertyPaginatorTypeDef
  5. See ComponentPropertyPaginatorTypeDef
  6. See ComponentPropertyPaginatorTypeDef
  7. See ComponentPropertyPaginatorTypeDef
  8. See MutationActionSetStateParameterPaginatorTypeDef

ActionParametersTypeDef#

# 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

ApiConfigurationTypeDef#

# ApiConfigurationTypeDef definition

class ApiConfigurationTypeDef(TypedDict):
    graphQLConfig: NotRequired[GraphQLRenderConfigTypeDef],  # (1)
    dataStoreConfig: NotRequired[Dict[str, Any]],
    noApiConfig: NotRequired[Dict[str, Any]],
  1. See GraphQLRenderConfigTypeDef

CodegenGenericDataFieldTypeDef#

# CodegenGenericDataFieldTypeDef definition

class CodegenGenericDataFieldTypeDef(TypedDict):
    dataType: CodegenGenericDataFieldDataTypeType,  # (1)
    dataTypeValue: str,
    required: bool,
    readOnly: bool,
    isArray: bool,
    relationship: NotRequired[CodegenGenericDataRelationshipTypeTypeDef],  # (2)
  1. See CodegenGenericDataFieldDataTypeType
  2. See CodegenGenericDataRelationshipTypeTypeDef

ComponentBindingPropertiesValuePaginatorTypeDef#

# ComponentBindingPropertiesValuePaginatorTypeDef definition

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

ComponentBindingPropertiesValueTypeDef#

# ComponentBindingPropertiesValueTypeDef definition

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

ComponentDataConfigurationPaginatorTypeDef#

# ComponentDataConfigurationPaginatorTypeDef definition

class ComponentDataConfigurationPaginatorTypeDef(TypedDict):
    model: str,
    sort: NotRequired[List[SortPropertyTypeDef]],  # (1)
    predicate: NotRequired[PredicatePaginatorTypeDef],  # (2)
    identifiers: NotRequired[List[str]],
  1. See SortPropertyTypeDef
  2. See PredicatePaginatorTypeDef

ComponentDataConfigurationTypeDef#

# 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

ComponentPropertyPaginatorTypeDef#

# ComponentPropertyPaginatorTypeDef definition

class ComponentPropertyPaginatorTypeDef(TypedDict):
    value: NotRequired[str],
    bindingProperties: NotRequired[ComponentPropertyBindingPropertiesTypeDef],  # (1)
    collectionBindingProperties: NotRequired[ComponentPropertyBindingPropertiesTypeDef],  # (1)
    defaultValue: NotRequired[str],
    model: NotRequired[str],
    bindings: NotRequired[Dict[str, FormBindingElementTypeDef]],  # (3)
    event: NotRequired[str],
    userAttribute: NotRequired[str],
    concat: NotRequired[List[Dict[str, Any]]],
    condition: NotRequired[ComponentConditionPropertyTypeDef],  # (4)
    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 ComponentConditionPropertyTypeDef

ComponentPropertyTypeDef#

# 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[Dict[str, Any]]],
    condition: NotRequired[Dict[str, Any]],
    configured: NotRequired[bool],
    type: NotRequired[str],
    importedValue: NotRequired[str],
    componentName: NotRequired[str],
    property: NotRequired[str],
  1. See ComponentPropertyBindingPropertiesTypeDef
  2. See ComponentPropertyBindingPropertiesTypeDef
  3. See FormBindingElementTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

ExchangeCodeForTokenResponseTypeDef#

# ExchangeCodeForTokenResponseTypeDef definition

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

GetMetadataResponseTypeDef#

# GetMetadataResponseTypeDef definition

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

ListCodegenJobsResponseTypeDef#

# ListCodegenJobsResponseTypeDef definition

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

ListComponentsResponseTypeDef#

# ListComponentsResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

RefreshTokenResponseTypeDef#

# RefreshTokenResponseTypeDef definition

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

FormSummaryTypeDef#

# 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

CreateThemeRequestRequestTypeDef#

# CreateThemeRequestRequestTypeDef definition

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

CreateThemeResponseTypeDef#

# CreateThemeResponseTypeDef definition

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

ExportThemesResponseTypeDef#

# ExportThemesResponseTypeDef definition

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

GetThemeResponseTypeDef#

# GetThemeResponseTypeDef definition

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

UpdateThemeResponseTypeDef#

# UpdateThemeResponseTypeDef definition

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

ExchangeCodeForTokenRequestRequestTypeDef#

# ExchangeCodeForTokenRequestRequestTypeDef definition

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

ExportComponentsRequestExportComponentsPaginateTypeDef#

# ExportComponentsRequestExportComponentsPaginateTypeDef definition

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

ExportFormsRequestExportFormsPaginateTypeDef#

# ExportFormsRequestExportFormsPaginateTypeDef definition

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

ExportThemesRequestExportThemesPaginateTypeDef#

# ExportThemesRequestExportThemesPaginateTypeDef definition

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

ListCodegenJobsRequestListCodegenJobsPaginateTypeDef#

# ListCodegenJobsRequestListCodegenJobsPaginateTypeDef definition

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

ListComponentsRequestListComponentsPaginateTypeDef#

# ListComponentsRequestListComponentsPaginateTypeDef definition

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

ListFormsRequestListFormsPaginateTypeDef#

# ListFormsRequestListFormsPaginateTypeDef definition

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

ListThemesRequestListThemesPaginateTypeDef#

# ListThemesRequestListThemesPaginateTypeDef definition

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

ExportThemesResponsePaginatorTypeDef#

# ExportThemesResponsePaginatorTypeDef definition

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

FormButtonTypeDef#

# FormButtonTypeDef definition

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

SectionalElementTypeDef#

# 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

FormInputBindingPropertiesValueTypeDef#

# FormInputBindingPropertiesValueTypeDef definition

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

FormInputValuePropertyPaginatorTypeDef#

# FormInputValuePropertyPaginatorTypeDef definition

class FormInputValuePropertyPaginatorTypeDef(TypedDict):
    value: NotRequired[str],
    bindingProperties: NotRequired[FormInputValuePropertyBindingPropertiesTypeDef],  # (1)
    concat: NotRequired[List[Dict[str, Any]]],
  1. See FormInputValuePropertyBindingPropertiesTypeDef

FormInputValuePropertyTypeDef#

# FormInputValuePropertyTypeDef definition

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

FormStyleTypeDef#

# 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

ListThemesResponseTypeDef#

# ListThemesResponseTypeDef definition

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

PutMetadataFlagRequestRequestTypeDef#

# PutMetadataFlagRequestRequestTypeDef definition

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

RefreshTokenRequestRequestTypeDef#

# RefreshTokenRequestRequestTypeDef definition

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

UpdateThemeRequestRequestTypeDef#

# UpdateThemeRequestRequestTypeDef definition

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

ComponentEventPaginatorTypeDef#

# ComponentEventPaginatorTypeDef definition

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

ComponentEventTypeDef#

# ComponentEventTypeDef definition

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

ReactStartCodegenJobDataTypeDef#

# ReactStartCodegenJobDataTypeDef definition

class ReactStartCodegenJobDataTypeDef(TypedDict):
    module: NotRequired[JSModuleType],  # (1)
    target: NotRequired[JSTargetType],  # (2)
    script: NotRequired[JSScriptType],  # (3)
    renderTypeDeclarations: NotRequired[bool],
    inlineSourceMap: NotRequired[bool],
    apiConfiguration: NotRequired[ApiConfigurationTypeDef],  # (4)
    dependencies: NotRequired[Dict[str, str]],
  1. See JSModuleType
  2. See JSTargetType
  3. See JSScriptType
  4. See ApiConfigurationTypeDef

CodegenGenericDataModelTypeDef#

# CodegenGenericDataModelTypeDef definition

class CodegenGenericDataModelTypeDef(TypedDict):
    fields: Dict[str, CodegenGenericDataFieldTypeDef],  # (1)
    primaryKeys: List[str],
    isJoinTable: NotRequired[bool],
  1. See CodegenGenericDataFieldTypeDef

CodegenGenericDataNonModelTypeDef#

# CodegenGenericDataNonModelTypeDef definition

class CodegenGenericDataNonModelTypeDef(TypedDict):
    fields: Dict[str, CodegenGenericDataFieldTypeDef],  # (1)
  1. See CodegenGenericDataFieldTypeDef

ListFormsResponseTypeDef#

# ListFormsResponseTypeDef definition

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

FormCTATypeDef#

# 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

ValueMappingsPaginatorTypeDef#

# ValueMappingsPaginatorTypeDef definition

class ValueMappingsPaginatorTypeDef(TypedDict):
    values: List[ValueMappingPaginatorTypeDef],  # (1)
    bindingProperties: NotRequired[Dict[str, FormInputBindingPropertiesValueTypeDef]],  # (2)
  1. See ValueMappingPaginatorTypeDef
  2. See FormInputBindingPropertiesValueTypeDef

ValueMappingsTypeDef#

# ValueMappingsTypeDef definition

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

ComponentChildPaginatorTypeDef#

# ComponentChildPaginatorTypeDef definition

class ComponentChildPaginatorTypeDef(TypedDict):
    componentType: str,
    name: str,
    properties: Dict[str, ComponentPropertyPaginatorTypeDef],  # (1)
    children: NotRequired[List[Dict[str, Any]]],
    events: NotRequired[Dict[str, ComponentEventPaginatorTypeDef]],  # (2)
    sourceId: NotRequired[str],
  1. See ComponentPropertyPaginatorTypeDef
  2. See ComponentEventPaginatorTypeDef

ComponentPaginatorTypeDef#

# ComponentPaginatorTypeDef definition

class ComponentPaginatorTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    id: str,
    name: str,
    componentType: str,
    properties: Dict[str, ComponentPropertyPaginatorTypeDef],  # (1)
    variants: List[ComponentVariantPaginatorTypeDef],  # (3)
    overrides: Dict[str, Dict[str, str]],
    bindingProperties: Dict[str, ComponentBindingPropertiesValuePaginatorTypeDef],  # (4)
    createdAt: datetime,
    sourceId: NotRequired[str],
    children: NotRequired[List[ComponentChildPaginatorTypeDef]],  # (2)
    collectionProperties: NotRequired[Dict[str, ComponentDataConfigurationPaginatorTypeDef]],  # (5)
    modifiedAt: NotRequired[datetime],
    tags: NotRequired[Dict[str, str]],
    events: NotRequired[Dict[str, ComponentEventPaginatorTypeDef]],  # (6)
    schemaVersion: NotRequired[str],
  1. See ComponentPropertyPaginatorTypeDef
  2. See ComponentChildPaginatorTypeDef
  3. See ComponentVariantPaginatorTypeDef
  4. See ComponentBindingPropertiesValuePaginatorTypeDef
  5. See ComponentDataConfigurationPaginatorTypeDef
  6. See ComponentEventPaginatorTypeDef

ComponentChildTypeDef#

# ComponentChildTypeDef definition

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

ComponentTypeDef#

# 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

CreateComponentDataTypeDef#

# 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

UpdateComponentDataTypeDef#

# 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

CodegenJobRenderConfigTypeDef#

# CodegenJobRenderConfigTypeDef definition

class CodegenJobRenderConfigTypeDef(TypedDict):
    react: NotRequired[ReactStartCodegenJobDataTypeDef],  # (1)
  1. See ReactStartCodegenJobDataTypeDef

CodegenJobGenericDataSchemaTypeDef#

# CodegenJobGenericDataSchemaTypeDef definition

class CodegenJobGenericDataSchemaTypeDef(TypedDict):
    dataSourceType: CodegenJobGenericDataSourceTypeType,  # (1)
    models: Dict[str, CodegenGenericDataModelTypeDef],  # (2)
    enums: Dict[str, CodegenGenericDataEnumTypeDef],  # (3)
    nonModels: Dict[str, CodegenGenericDataNonModelTypeDef],  # (4)
  1. See CodegenJobGenericDataSourceTypeType
  2. See CodegenGenericDataModelTypeDef
  3. See CodegenGenericDataEnumTypeDef
  4. See CodegenGenericDataNonModelTypeDef

FieldInputConfigPaginatorTypeDef#

# FieldInputConfigPaginatorTypeDef definition

class FieldInputConfigPaginatorTypeDef(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[ValueMappingsPaginatorTypeDef],  # (1)
    name: NotRequired[str],
    minValue: NotRequired[float],
    maxValue: NotRequired[float],
    step: NotRequired[float],
    value: NotRequired[str],
    isArray: NotRequired[bool],
    fileUploaderConfig: NotRequired[FileUploaderFieldConfigPaginatorTypeDef],  # (2)
  1. See ValueMappingsPaginatorTypeDef
  2. See FileUploaderFieldConfigPaginatorTypeDef

FieldInputConfigTypeDef#

# 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

ExportComponentsResponsePaginatorTypeDef#

# ExportComponentsResponsePaginatorTypeDef definition

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

CreateComponentResponseTypeDef#

# CreateComponentResponseTypeDef definition

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

ExportComponentsResponseTypeDef#

# ExportComponentsResponseTypeDef definition

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

GetComponentResponseTypeDef#

# GetComponentResponseTypeDef definition

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

UpdateComponentResponseTypeDef#

# UpdateComponentResponseTypeDef definition

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

CreateComponentRequestRequestTypeDef#

# CreateComponentRequestRequestTypeDef definition

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

UpdateComponentRequestRequestTypeDef#

# UpdateComponentRequestRequestTypeDef definition

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

CodegenJobTypeDef#

# CodegenJobTypeDef definition

class CodegenJobTypeDef(TypedDict):
    id: str,
    appId: str,
    environmentName: str,
    renderConfig: NotRequired[CodegenJobRenderConfigTypeDef],  # (1)
    genericDataSchema: NotRequired[CodegenJobGenericDataSchemaTypeDef],  # (2)
    autoGenerateForms: NotRequired[bool],
    features: NotRequired[CodegenFeatureFlagsTypeDef],  # (3)
    status: NotRequired[CodegenJobStatusType],  # (4)
    statusMessage: NotRequired[str],
    asset: NotRequired[CodegenJobAssetTypeDef],  # (5)
    tags: NotRequired[Dict[str, str]],
    createdAt: NotRequired[datetime],
    modifiedAt: NotRequired[datetime],
    dependencies: NotRequired[List[CodegenDependencyTypeDef]],  # (6)
  1. See CodegenJobRenderConfigTypeDef
  2. See CodegenJobGenericDataSchemaTypeDef
  3. See CodegenFeatureFlagsTypeDef
  4. See CodegenJobStatusType
  5. See CodegenJobAssetTypeDef
  6. See CodegenDependencyTypeDef

StartCodegenJobDataTypeDef#

# StartCodegenJobDataTypeDef definition

class StartCodegenJobDataTypeDef(TypedDict):
    renderConfig: CodegenJobRenderConfigTypeDef,  # (1)
    genericDataSchema: NotRequired[CodegenJobGenericDataSchemaTypeDef],  # (2)
    autoGenerateForms: NotRequired[bool],
    features: NotRequired[CodegenFeatureFlagsTypeDef],  # (3)
    tags: NotRequired[Mapping[str, str]],
  1. See CodegenJobRenderConfigTypeDef
  2. See CodegenJobGenericDataSchemaTypeDef
  3. See CodegenFeatureFlagsTypeDef

FieldConfigPaginatorTypeDef#

# FieldConfigPaginatorTypeDef definition

class FieldConfigPaginatorTypeDef(TypedDict):
    label: NotRequired[str],
    position: NotRequired[FieldPositionTypeDef],  # (1)
    excluded: NotRequired[bool],
    inputType: NotRequired[FieldInputConfigPaginatorTypeDef],  # (2)
    validations: NotRequired[List[FieldValidationConfigurationPaginatorTypeDef]],  # (3)
  1. See FieldPositionTypeDef
  2. See FieldInputConfigPaginatorTypeDef
  3. See FieldValidationConfigurationPaginatorTypeDef

FieldConfigTypeDef#

# 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

GetCodegenJobResponseTypeDef#

# GetCodegenJobResponseTypeDef definition

class GetCodegenJobResponseTypeDef(TypedDict):
    job: CodegenJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CodegenJobTypeDef
  2. See ResponseMetadataTypeDef

StartCodegenJobResponseTypeDef#

# StartCodegenJobResponseTypeDef definition

class StartCodegenJobResponseTypeDef(TypedDict):
    entity: CodegenJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CodegenJobTypeDef
  2. See ResponseMetadataTypeDef

StartCodegenJobRequestRequestTypeDef#

# StartCodegenJobRequestRequestTypeDef definition

class StartCodegenJobRequestRequestTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    codegenJobToCreate: StartCodegenJobDataTypeDef,  # (1)
    clientToken: NotRequired[str],
  1. See StartCodegenJobDataTypeDef

FormPaginatorTypeDef#

# FormPaginatorTypeDef definition

class FormPaginatorTypeDef(TypedDict):
    appId: str,
    environmentName: str,
    id: str,
    name: str,
    formActionType: FormActionTypeType,  # (1)
    style: FormStyleTypeDef,  # (2)
    dataType: FormDataTypeConfigTypeDef,  # (3)
    fields: Dict[str, FieldConfigPaginatorTypeDef],  # (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 FieldConfigPaginatorTypeDef
  5. See SectionalElementTypeDef
  6. See FormCTATypeDef
  7. See LabelDecoratorType

CreateFormDataTypeDef#

# 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

FormTypeDef#

# 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

UpdateFormDataTypeDef#

# 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

ExportFormsResponsePaginatorTypeDef#

# ExportFormsResponsePaginatorTypeDef definition

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

CreateFormRequestRequestTypeDef#

# CreateFormRequestRequestTypeDef definition

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

CreateFormResponseTypeDef#

# CreateFormResponseTypeDef definition

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

ExportFormsResponseTypeDef#

# ExportFormsResponseTypeDef definition

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

GetFormResponseTypeDef#

# GetFormResponseTypeDef definition

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

UpdateFormResponseTypeDef#

# UpdateFormResponseTypeDef definition

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

UpdateFormRequestRequestTypeDef#

# UpdateFormRequestRequestTypeDef definition

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