AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Amplify UI Builder CreateForm API operation.

Syntax

New-AMPUIForm
-AppId <String>
-FormToCreate_Cta_Cancel_Position_Below <String>
-FormToCreate_Cta_Clear_Position_Below <String>
-FormToCreate_Cta_Submit_Position_Below <String>
-Cancel_Child <String>
-Clear_Child <String>
-Submit_Child <String>
-DataType_DataSourceType <FormDataSourceType>
-DataType_DataTypeName <String>
-EnvironmentName <String>
-Cancel_Excluded <Boolean>
-Clear_Excluded <Boolean>
-Submit_Excluded <Boolean>
-FormToCreate_Field <Hashtable>
-FormToCreate_Cta_Cancel_Position_Fixed <FixedPosition>
-FormToCreate_Cta_Clear_Position_Fixed <FixedPosition>
-FormToCreate_Cta_Submit_Position_Fixed <FixedPosition>
-FormToCreate_FormActionType <FormActionType>
-FormToCreate_LabelDecorator <LabelDecorator>
-FormToCreate_Name <String>
-Cta_Position <FormButtonsPosition>
-FormToCreate_Cta_Cancel_Position_RightOf <String>
-FormToCreate_Cta_Clear_Position_RightOf <String>
-FormToCreate_Cta_Submit_Position_RightOf <String>
-FormToCreate_SchemaVersion <String>
-FormToCreate_SectionalElement <Hashtable>
-FormToCreate_Tag <Hashtable>
-HorizontalGap_TokenReference <String>
-OuterPadding_TokenReference <String>
-VerticalGap_TokenReference <String>
-HorizontalGap_Value <String>
-OuterPadding_Value <String>
-VerticalGap_Value <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonAmplifyUIBuilderConfig>

Description

Creates a new form for an Amplify app.

Parameters

-AppId <String>
The unique ID of the Amplify app to associate with the form.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Cancel_Child <String>
Describes the button's properties.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Cta_Cancel_Children
-Cancel_Excluded <Boolean>
Specifies whether the button is visible on the form.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Cta_Cancel_Excluded
-Clear_Child <String>
Describes the button's properties.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Cta_Clear_Children
-Clear_Excluded <Boolean>
Specifies whether the button is visible on the form.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Cta_Clear_Excluded
-ClientConfig <AmazonAmplifyUIBuilderConfig>
Amazon.PowerShell.Cmdlets.AMPUI.AmazonAmplifyUIBuilderClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
The unique client token.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Cta_Position <FormButtonsPosition>
The position of the button.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Cta_Position
-DataType_DataSourceType <FormDataSourceType>
The data source type, either an Amplify DataStore model or a custom data type.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_DataType_DataSourceType
-DataType_DataTypeName <String>
The unique name of the data type you are using as the data source for the form.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_DataType_DataTypeName
-EnvironmentName <String>
The name of the backend environment that is a part of the Amplify app.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FormToCreate_Cta_Cancel_Position_Below <String>
The field position is below the field specified by the string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCreate_Form_Cancel_Position_Below
-FormToCreate_Cta_Cancel_Position_Fixed <FixedPosition>
The field position is fixed and doesn't change in relation to other fields.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCreate_Form_Cancel_Position_Fixed
-FormToCreate_Cta_Cancel_Position_RightOf <String>
The field position is to the right of the field specified by the string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCreate_Form_Cancel_Position_RightOf
-FormToCreate_Cta_Clear_Position_Below <String>
The field position is below the field specified by the string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCreate_Form_Clear_Position_Below
-FormToCreate_Cta_Clear_Position_Fixed <FixedPosition>
The field position is fixed and doesn't change in relation to other fields.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCreate_Form_Clear_Position_Fixed
-FormToCreate_Cta_Clear_Position_RightOf <String>
The field position is to the right of the field specified by the string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCreate_Form_Clear_Position_RightOf
-FormToCreate_Cta_Submit_Position_Below <String>
The field position is below the field specified by the string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCreate_Form_Submit_Position_Below
-FormToCreate_Cta_Submit_Position_Fixed <FixedPosition>
The field position is fixed and doesn't change in relation to other fields.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCreate_Form_Submit_Position_Fixed
-FormToCreate_Cta_Submit_Position_RightOf <String>
The field position is to the right of the field specified by the string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCreate_Form_Submit_Position_RightOf
-FormToCreate_Field <Hashtable>
The configuration information for the form's fields. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Fields
-FormToCreate_FormActionType <FormActionType>
Specifies whether to perform a create or update action on the form.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-FormToCreate_LabelDecorator <LabelDecorator>
Specifies an icon or decoration to display on the form.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FormToCreate_Name <String>
The name of the form.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-FormToCreate_SchemaVersion <String>
The schema version of the form.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-FormToCreate_SectionalElement <Hashtable>
The configuration information for the visual helper elements for the form. These elements are not associated with any data. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_SectionalElements
-FormToCreate_Tag <Hashtable>
One or more key-value pairs to use when tagging the form data. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Tags
-HorizontalGap_TokenReference <String>
A reference to a design token to use to bind the form's style properties to an existing theme.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Style_HorizontalGap_TokenReference
-HorizontalGap_Value <String>
The value of the style setting.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Style_HorizontalGap_Value
-OuterPadding_TokenReference <String>
A reference to a design token to use to bind the form's style properties to an existing theme.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Style_OuterPadding_TokenReference
-OuterPadding_Value <String>
The value of the style setting.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Style_OuterPadding_Value
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Entity'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyUIBuilder.Model.CreateFormResponse). Specifying the name of a property of type Amazon.AmplifyUIBuilder.Model.CreateFormResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Submit_Child <String>
Describes the button's properties.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Cta_Submit_Children
-Submit_Excluded <Boolean>
Specifies whether the button is visible on the form.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Cta_Submit_Excluded
-VerticalGap_TokenReference <String>
A reference to a design token to use to bind the form's style properties to an existing theme.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Style_VerticalGap_TokenReference
-VerticalGap_Value <String>
The value of the style setting.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFormToCreate_Style_VerticalGap_Value

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.AmplifyUIBuilder.Model.Form or Amazon.AmplifyUIBuilder.Model.CreateFormResponse
This cmdlet returns an Amazon.AmplifyUIBuilder.Model.Form object. The service call response (type Amazon.AmplifyUIBuilder.Model.CreateFormResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z