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)
MutationActionSetStateParameterTypeDef#
# MutationActionSetStateParameterTypeDef definition
class MutationActionSetStateParameterTypeDef(TypedDict):
componentName: str,
property: str,
set: ComponentPropertyTypeDef, # (1)
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],
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],
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],
- 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],
SortPropertyTypeDef#
# SortPropertyTypeDef definition
class SortPropertyTypeDef(TypedDict):
field: str,
direction: SortDirectionType, # (1)
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,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
FormDataTypeConfigTypeDef#
# FormDataTypeConfigTypeDef definition
class FormDataTypeConfigTypeDef(TypedDict):
dataSourceType: FormDataSourceTypeType, # (1)
dataTypeName: str,
CreateThemeDataTypeDef#
# CreateThemeDataTypeDef definition
class CreateThemeDataTypeDef(TypedDict):
name: str,
values: Sequence[ThemeValuesTypeDef], # (1)
overrides: NotRequired[Sequence[ThemeValuesTypeDef]], # (1)
tags: NotRequired[Mapping[str, str]],
- See ThemeValuesTypeDef
- 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]],
- See ThemeValuesTypeDef
- 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]],
FieldPositionTypeDef#
# FieldPositionTypeDef definition
class FieldPositionTypeDef(TypedDict):
fixed: NotRequired[FixedPositionType], # (1)
rightOf: NotRequired[str],
below: NotRequired[str],
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],
FileUploaderFieldConfigTypeDef#
# FileUploaderFieldConfigTypeDef definition
class FileUploaderFieldConfigTypeDef(TypedDict):
accessLevel: StorageAccessLevelType, # (1)
acceptedFileTypes: Sequence[str],
showThumbnails: NotRequired[bool],
isResumable: NotRequired[bool],
maxFileCount: NotRequired[int],
maxSize: NotRequired[int],
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],
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],
ThemeValuePaginatorTypeDef#
# ThemeValuePaginatorTypeDef definition
class ThemeValuePaginatorTypeDef(TypedDict):
value: NotRequired[str],
children: NotRequired[List[ThemeValuesPaginatorTypeDef]], # (1)
ThemeValueTypeDef#
# ThemeValueTypeDef definition
class ThemeValueTypeDef(TypedDict):
value: NotRequired[str],
children: NotRequired[Sequence[ThemeValuesTypeDef]], # (1)
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]],
UpdateThemeDataTypeDef#
# UpdateThemeDataTypeDef definition
class UpdateThemeDataTypeDef(TypedDict):
values: Sequence[ThemeValuesTypeDef], # (1)
id: NotRequired[str],
name: NotRequired[str],
overrides: NotRequired[Sequence[ThemeValuesTypeDef]], # (1)
- See ThemeValuesTypeDef
- See ThemeValuesTypeDef
ValueMappingPaginatorTypeDef#
# ValueMappingPaginatorTypeDef definition
class ValueMappingPaginatorTypeDef(TypedDict):
value: FormInputValuePropertyPaginatorTypeDef, # (1)
displayValue: NotRequired[FormInputValuePropertyPaginatorTypeDef], # (1)
ValueMappingTypeDef#
# ValueMappingTypeDef definition
class ValueMappingTypeDef(TypedDict):
value: FormInputValuePropertyTypeDef, # (1)
displayValue: NotRequired[FormInputValuePropertyTypeDef], # (1)
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)
- See ComponentPropertyPaginatorTypeDef
- See ComponentPropertyPaginatorTypeDef
- See ComponentPropertyPaginatorTypeDef
- See ComponentPropertyPaginatorTypeDef
- See ComponentPropertyPaginatorTypeDef
- See ComponentPropertyPaginatorTypeDef
- See ComponentPropertyPaginatorTypeDef
- 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)
- See ComponentPropertyTypeDef
- See ComponentPropertyTypeDef
- See ComponentPropertyTypeDef
- See ComponentPropertyTypeDef
- See ComponentPropertyTypeDef
- See ComponentPropertyTypeDef
- See ComponentPropertyTypeDef
- See MutationActionSetStateParameterTypeDef
ApiConfigurationTypeDef#
# ApiConfigurationTypeDef definition
class ApiConfigurationTypeDef(TypedDict):
graphQLConfig: NotRequired[GraphQLRenderConfigTypeDef], # (1)
dataStoreConfig: NotRequired[Dict[str, Any]],
noApiConfig: NotRequired[Dict[str, Any]],
CodegenGenericDataFieldTypeDef#
# CodegenGenericDataFieldTypeDef definition
class CodegenGenericDataFieldTypeDef(TypedDict):
dataType: CodegenGenericDataFieldDataTypeType, # (1)
dataTypeValue: str,
required: bool,
readOnly: bool,
isArray: bool,
relationship: NotRequired[CodegenGenericDataRelationshipTypeTypeDef], # (2)
ComponentBindingPropertiesValuePaginatorTypeDef#
# ComponentBindingPropertiesValuePaginatorTypeDef definition
class ComponentBindingPropertiesValuePaginatorTypeDef(TypedDict):
type: NotRequired[str],
bindingProperties: NotRequired[ComponentBindingPropertiesValuePropertiesPaginatorTypeDef], # (1)
defaultValue: NotRequired[str],
ComponentBindingPropertiesValueTypeDef#
# ComponentBindingPropertiesValueTypeDef definition
class ComponentBindingPropertiesValueTypeDef(TypedDict):
type: NotRequired[str],
bindingProperties: NotRequired[ComponentBindingPropertiesValuePropertiesTypeDef], # (1)
defaultValue: NotRequired[str],
ComponentDataConfigurationPaginatorTypeDef#
# ComponentDataConfigurationPaginatorTypeDef definition
class ComponentDataConfigurationPaginatorTypeDef(TypedDict):
model: str,
sort: NotRequired[List[SortPropertyTypeDef]], # (1)
predicate: NotRequired[PredicatePaginatorTypeDef], # (2)
identifiers: NotRequired[List[str]],
ComponentDataConfigurationTypeDef#
# ComponentDataConfigurationTypeDef definition
class ComponentDataConfigurationTypeDef(TypedDict):
model: str,
sort: NotRequired[Sequence[SortPropertyTypeDef]], # (1)
predicate: NotRequired[PredicateTypeDef], # (2)
identifiers: NotRequired[Sequence[str]],
- See SortPropertyTypeDef
- 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],