AWS.Tools.AmplifyBackend.XML
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.AmplifyBackend</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.CopyAMPBBackendCmdlet"> <summary> This operation clones an existing backend. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.CopyAMPBBackendCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.CopyAMPBBackendCmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.CopyAMPBBackendCmdlet.TargetEnvironmentName"> <summary> <para> <para>The name of the destination backend environment to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.CopyAMPBBackendCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.CloneBackendResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.CloneBackendResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.CopyAMPBBackendCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.CopyAMPBBackendCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendCmdlet"> <summary> Provides project-level details for your Amplify UI project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendCmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.GetBackendResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.GetBackendResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet"> <summary> Gets the details for a backend API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.ResourceConfig_AdditionalAuthType"> <summary> <para> <para>Additional authentication methods used to interact with your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.ResourceConfig_ApiName"> <summary> <para> <para>The API name used to interact with the data model, configured as a part of the Amplify project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.Settings_CognitoUserPoolId"> <summary> <para> <para>The Amazon Cognito user pool ID, if Amazon Cognito is used as an authentication setting to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.Settings_Description"> <summary> <para> <para>The API key description for API_KEY, if it is used as an authentication mechanism to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.Settings_ExpirationTime"> <summary> <para> <para>The API key expiration time for API_KEY, if it is used as an authentication mechanism to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.DefaultAuthType_Mode"> <summary> <para> <para>Describes the authentication mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.Settings_OpenIDAuthTTL"> <summary> <para> <para>The expiry time for the OpenID authentication mechanism.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.Settings_OpenIDClientId"> <summary> <para> <para>The clientID for openID, if openID is used as an authentication setting to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.Settings_OpenIDIatTTL"> <summary> <para> <para>The expiry time for the OpenID authentication mechanism.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.Settings_OpenIDIssueURL"> <summary> <para> <para>The openID issuer URL, if openID is used as an authentication setting to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.Settings_OpenIDProviderName"> <summary> <para> <para>The openID provider name, if openID is used as an authentication mechanism to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.ConflictResolution_ResolutionStrategy"> <summary> <para> <para>The strategy for conflict resolution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.ResourceName"> <summary> <para> <para>The name of this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.ResourceConfig_Service"> <summary> <para> <para>The service used to provision and interact with the data model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.ResourceConfig_TransformSchema"> <summary> <para> <para>The definition of the data model in the annotated transform of the GraphQL schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.GetBackendAPIResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.GetBackendAPIResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPICmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPIModelCmdlet"> <summary> Generates a model schema for existing backend API resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPIModelCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPIModelCmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPIModelCmdlet.ResourceName"> <summary> <para> <para>The name of this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPIModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.GetBackendAPIModelsResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.GetBackendAPIModelsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAPIModelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAuthCmdlet"> <summary> Gets backend auth details. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAuthCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAuthCmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAuthCmdlet.ResourceName"> <summary> <para> <para>The name of this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAuthCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.GetBackendAuthResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.GetBackendAuthResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendAuthCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobCmdlet"> <summary> Returns information about a specific job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobCmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobCmdlet.JobId"> <summary> <para> <para>The ID for the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.GetBackendJobResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.GetBackendJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobListCmdlet"> <summary> Lists the jobs for the backend of an Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobListCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobListCmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobListCmdlet.JobId"> <summary> <para> <para>The ID for the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobListCmdlet.Operation"> <summary> <para> <para>Filters the list of response objects to include only those with the specified operation name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobListCmdlet.Status"> <summary> <para> <para>Filters the list of response objects to include only those with the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Jobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.ListBackendJobsResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.ListBackendJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBBackendJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBTokenCmdlet"> <summary> Gets the challenge token based on the given appId and sessionId. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBTokenCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBTokenCmdlet.SessionId"> <summary> <para> <para>The session ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBTokenCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.GetTokenResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.GetTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.GetAMPBTokenCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendCmdlet"> <summary> This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendCmdlet.AppName"> <summary> <para> <para>The name of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendCmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendCmdlet.ResourceConfig"> <summary> <para> <para>The resource configuration for the backend creation request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendCmdlet.ResourceName"> <summary> <para> <para>The name of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.CreateBackendResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.CreateBackendResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet"> <summary> Creates a new backend API resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.ResourceConfig_AdditionalAuthType"> <summary> <para> <para>Additional authentication methods used to interact with your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.ResourceConfig_ApiName"> <summary> <para> <para>The API name used to interact with the data model, configured as a part of the Amplify project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.Settings_CognitoUserPoolId"> <summary> <para> <para>The Amazon Cognito user pool ID, if Amazon Cognito is used as an authentication setting to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.Settings_Description"> <summary> <para> <para>The API key description for API_KEY, if it is used as an authentication mechanism to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.Settings_ExpirationTime"> <summary> <para> <para>The API key expiration time for API_KEY, if it is used as an authentication mechanism to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.DefaultAuthType_Mode"> <summary> <para> <para>Describes the authentication mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.Settings_OpenIDAuthTTL"> <summary> <para> <para>The expiry time for the OpenID authentication mechanism.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.Settings_OpenIDClientId"> <summary> <para> <para>The clientID for openID, if openID is used as an authentication setting to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.Settings_OpenIDIatTTL"> <summary> <para> <para>The expiry time for the OpenID authentication mechanism.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.Settings_OpenIDIssueURL"> <summary> <para> <para>The openID issuer URL, if openID is used as an authentication setting to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.Settings_OpenIDProviderName"> <summary> <para> <para>The openID provider name, if openID is used as an authentication mechanism to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.ConflictResolution_ResolutionStrategy"> <summary> <para> <para>The strategy for conflict resolution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.ResourceName"> <summary> <para> <para>The name of this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.ResourceConfig_Service"> <summary> <para> <para>The service used to provision and interact with the data model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.ResourceConfig_TransformSchema"> <summary> <para> <para>The definition of the data model in the annotated transform of the GraphQL schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.CreateBackendAPIResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.CreateBackendAPIResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPICmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPIModelCmdlet"> <summary> Generates a model schema for an existing backend API resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPIModelCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPIModelCmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPIModelCmdlet.ResourceName"> <summary> <para> <para>The name of this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPIModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.GenerateBackendAPIModelsResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.GenerateBackendAPIModelsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPIModelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAPIModelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet"> <summary> Creates a new backend authentication resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.PasswordPolicy_AdditionalConstraint"> <summary> <para> <para>Additional constraints for the password used to access the backend of your Amplify project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.ResourceConfig_AuthResource"> <summary> <para> <para>Defines whether you want to configure only authentication or both authentication and authorization settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.Facebook_ClientId"> <summary> <para> <para>Describes the client_id that can be obtained from the third-party social federation provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.Google_ClientId"> <summary> <para> <para>Describes the client_id that can be obtained from the third-party social federation provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.LoginWithAmazon_ClientId"> <summary> <para> <para>Describes the client_id that can be obtained from the third-party social federation provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.Facebook_ClientSecret"> <summary> <para> <para>Describes the client_secret that can be obtained from third-party social federation providers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.Google_ClientSecret"> <summary> <para> <para>Describes the client_secret that can be obtained from third-party social federation providers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.LoginWithAmazon_ClientSecret"> <summary> <para> <para>Describes the client_secret that can be obtained from third-party social federation providers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.ForgotPassword_DeliveryMethod"> <summary> <para> <para>Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.OAuth_DomainPrefix"> <summary> <para> <para>The domain prefix for your Amplify app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.EmailSettings_EmailMessage"> <summary> <para> <para>The body of the email.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.EmailSettings_EmailSubject"> <summary> <para> <para>The subject of the email.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.IdentityPoolConfigs_IdentityPoolName"> <summary> <para> <para>Name of the identity pool used for authorization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.Mfa_MFAMode"> <summary> <para> <para>Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.Settings_MfaType"> <summary> <para> <para>The supported MFA types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.PasswordPolicy_MinimumLength"> <summary> <para> <para>The minimum length of the password used to access the backend of your Amplify project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.OAuth_OAuthGrantType"> <summary> <para> <para>The OAuth grant type that you use to allow app users to authenticate from your Amplify app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.OAuth_OAuthScope"> <summary> <para> <para>List of OAuth-related flows that allow your app users to authenticate from your Amplify app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.OAuth_RedirectSignInURIs"> <summary> <para> <para>The redirected URI for signing in to your Amplify app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.OAuth_RedirectSignOutURIs"> <summary> <para> <para>Redirect URLs that OAuth uses when a user signs out of an Amplify app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.UserPoolConfigs_RequiredSignUpAttribute"> <summary> <para> <para>The required attributes to sign up new users in the Amazon Cognito user pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.ResourceName"> <summary> <para> <para>The name of this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.ResourceConfig_Service"> <summary> <para> <para>Defines the service name to use when configuring an authentication resource in your Amplify project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.UserPoolConfigs_SignInMethod"> <summary> <para> <para>Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.SmsSettings_SmsMessage"> <summary> <para> <para>The body of the SMS message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.Settings_SmsMessage"> <summary> <para> <para>The body of the SMS message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.IdentityPoolConfigs_UnauthenticatedLogin"> <summary> <para> <para>Set to true or false based on whether you want to enable guest authorization to your Amplify app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.UserPoolConfigs_UserPoolName"> <summary> <para> <para>The Amazon Cognito user pool name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.CreateBackendAuthResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.CreateBackendAuthResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendAuthCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendConfigCmdlet"> <summary> Creates a config object for a backend. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendConfigCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendConfigCmdlet.BackendManagerAppId"> <summary> <para> <para>The app ID for the backend manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.CreateBackendConfigResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.CreateBackendConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBBackendConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBTokenCmdlet"> <summary> Generates a one-time challenge code to authenticate a user into your Amplify Admin UI. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBTokenCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBTokenCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.CreateTokenResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.CreateTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBTokenCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.NewAMPBTokenCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBAllBackendCmdlet"> <summary> Removes all backend environments from your Amplify project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBAllBackendCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBAllBackendCmdlet.CleanAmplifyApp"> <summary> <para> <para>Cleans up the Amplify Console app if this value is set to true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBAllBackendCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.RemoveAllBackendsResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.RemoveAllBackendsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBAllBackendCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBAllBackendCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendCmdlet"> <summary> Removes an existing environment from your Amplify project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendCmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.DeleteBackendResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.DeleteBackendResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet"> <summary> Deletes an existing backend API resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.ResourceConfig_AdditionalAuthType"> <summary> <para> <para>Additional authentication methods used to interact with your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.ResourceConfig_ApiName"> <summary> <para> <para>The API name used to interact with the data model, configured as a part of the Amplify project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.Settings_CognitoUserPoolId"> <summary> <para> <para>The Amazon Cognito user pool ID, if Amazon Cognito is used as an authentication setting to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.Settings_Description"> <summary> <para> <para>The API key description for API_KEY, if it is used as an authentication mechanism to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.Settings_ExpirationTime"> <summary> <para> <para>The API key expiration time for API_KEY, if it is used as an authentication mechanism to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.DefaultAuthType_Mode"> <summary> <para> <para>Describes the authentication mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.Settings_OpenIDAuthTTL"> <summary> <para> <para>The expiry time for the OpenID authentication mechanism.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.Settings_OpenIDClientId"> <summary> <para> <para>The clientID for openID, if openID is used as an authentication setting to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.Settings_OpenIDIatTTL"> <summary> <para> <para>The expiry time for the OpenID authentication mechanism.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.Settings_OpenIDIssueURL"> <summary> <para> <para>The openID issuer URL, if openID is used as an authentication setting to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.Settings_OpenIDProviderName"> <summary> <para> <para>The openID provider name, if openID is used as an authentication mechanism to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.ConflictResolution_ResolutionStrategy"> <summary> <para> <para>The strategy for conflict resolution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.ResourceName"> <summary> <para> <para>The name of this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.ResourceConfig_Service"> <summary> <para> <para>The service used to provision and interact with the data model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.ResourceConfig_TransformSchema"> <summary> <para> <para>The definition of the data model in the annotated transform of the GraphQL schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.DeleteBackendAPIResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.DeleteBackendAPIResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAPICmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAuthCmdlet"> <summary> Deletes an existing backend authentication resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAuthCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAuthCmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAuthCmdlet.ResourceName"> <summary> <para> <para>The name of this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAuthCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.DeleteBackendAuthResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.DeleteBackendAuthResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAuthCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendAuthCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendConfigCmdlet"> <summary> Removes the AWS resources that are required to access the Amplify Admin UI. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendConfigCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Error'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.RemoveBackendConfigResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.RemoveBackendConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBBackendConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBTokenCmdlet"> <summary> Deletes the challenge token based on the given appId and sessionId. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBTokenCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBTokenCmdlet.SessionId"> <summary> <para> <para>The session ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBTokenCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IsSuccess'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.DeleteTokenResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.DeleteTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBTokenCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.RemoveAMPBTokenCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet"> <summary> Updates an existing backend API resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.ResourceConfig_AdditionalAuthType"> <summary> <para> <para>Additional authentication methods used to interact with your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.ResourceConfig_ApiName"> <summary> <para> <para>The API name used to interact with the data model, configured as a part of the Amplify project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.Settings_CognitoUserPoolId"> <summary> <para> <para>The Amazon Cognito user pool ID, if Amazon Cognito is used as an authentication setting to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.Settings_Description"> <summary> <para> <para>The API key description for API_KEY, if it is used as an authentication mechanism to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.Settings_ExpirationTime"> <summary> <para> <para>The API key expiration time for API_KEY, if it is used as an authentication mechanism to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.DefaultAuthType_Mode"> <summary> <para> <para>Describes the authentication mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.Settings_OpenIDAuthTTL"> <summary> <para> <para>The expiry time for the OpenID authentication mechanism.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.Settings_OpenIDClientId"> <summary> <para> <para>The clientID for openID, if openID is used as an authentication setting to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.Settings_OpenIDIatTTL"> <summary> <para> <para>The expiry time for the OpenID authentication mechanism.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.Settings_OpenIDIssueURL"> <summary> <para> <para>The openID issuer URL, if openID is used as an authentication setting to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.Settings_OpenIDProviderName"> <summary> <para> <para>The openID provider name, if openID is used as an authentication mechanism to access your data models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.ConflictResolution_ResolutionStrategy"> <summary> <para> <para>The strategy for conflict resolution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.ResourceName"> <summary> <para> <para>The name of this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.ResourceConfig_Service"> <summary> <para> <para>The service used to provision and interact with the data model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.ResourceConfig_TransformSchema"> <summary> <para> <para>The definition of the data model in the annotated transform of the GraphQL schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.UpdateBackendAPIResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.UpdateBackendAPIResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAPICmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet"> <summary> Updates an existing backend authentication resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.PasswordPolicy_AdditionalConstraint"> <summary> <para> <para>Describes additional constrains on the password requirements to sign in to the auth resource, configured as a part of your Amplify project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.ResourceConfig_AuthResource"> <summary> <para> <para>Defines the service name to use when configuring an authentication resource in your Amplify project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.Facebook_ClientId"> <summary> <para> <para>Describes the client_id that can be obtained from the third-party social federation provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.Google_ClientId"> <summary> <para> <para>Describes the client_id that can be obtained from the third-party social federation provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.LoginWithAmazon_ClientId"> <summary> <para> <para>Describes the client_id that can be obtained from the third-party social federation provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.Facebook_ClientSecret"> <summary> <para> <para>Describes the client_secret that can be obtained from third-party social federation providers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.Google_ClientSecret"> <summary> <para> <para>Describes the client_secret that can be obtained from third-party social federation providers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.LoginWithAmazon_ClientSecret"> <summary> <para> <para>Describes the client_secret that can be obtained from third-party social federation providers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.ForgotPassword_DeliveryMethod"> <summary> <para> <para>Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.OAuth_DomainPrefix"> <summary> <para> <para>The Amazon Cognito domain prefix used to create a hosted UI for authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.EmailSettings_EmailMessage"> <summary> <para> <para>The body of the email.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.EmailSettings_EmailSubject"> <summary> <para> <para>The subject of the email.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.Mfa_MFAMode"> <summary> <para> <para>The MFA mode for the backend of your Amplify project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.Settings_MfaType"> <summary> <para> <para>The supported MFA types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.PasswordPolicy_MinimumLength"> <summary> <para> <para>Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.OAuth_OAuthGrantType"> <summary> <para> <para>The OAuth grant type to allow app users to authenticate from your Amplify app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.OAuth_OAuthScope"> <summary> <para> <para>The list of OAuth-related flows that can allow users to authenticate from your Amplify app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.OAuth_RedirectSignInURIs"> <summary> <para> <para>Redirect URLs that OAuth uses when a user signs in to an Amplify app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.OAuth_RedirectSignOutURIs"> <summary> <para> <para>Redirect URLs that OAuth uses when a user signs out of an Amplify app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.ResourceName"> <summary> <para> <para>The name of this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.ResourceConfig_Service"> <summary> <para> <para>Defines the service name to use when configuring an authentication resource in your Amplify project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.SmsSettings_SmsMessage"> <summary> <para> <para>The body of the SMS message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.Settings_SmsMessage"> <summary> <para> <para>The body of the SMS message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.IdentityPoolConfigs_UnauthenticatedLogin"> <summary> <para> <para>A Boolean value that you can set to allow or disallow guest-level authorization into your Amplify app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.UpdateBackendAuthResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.UpdateBackendAuthResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendAuthCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendConfigCmdlet"> <summary> Updates the AWS resources that are required to access the Amplify Admin UI. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendConfigCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendConfigCmdlet.LoginAuthConfig_AwsCognitoIdentityPoolId"> <summary> <para> <para>The Amazon Cognito identity pool ID used for Amplify Admin UI login authorization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendConfigCmdlet.LoginAuthConfig_AwsCognitoRegion"> <summary> <para> <para>The AWS Region for the Amplify Admin UI login.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendConfigCmdlet.LoginAuthConfig_AwsUserPoolsId"> <summary> <para> <para>The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendConfigCmdlet.LoginAuthConfig_AwsUserPoolsWebClientId"> <summary> <para> <para>The web client ID for the Amazon Cognito user pools.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.UpdateBackendConfigResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.UpdateBackendConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendJobCmdlet"> <summary> Updates a specific job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendJobCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendJobCmdlet.BackendEnvironmentName"> <summary> <para> <para>The name of the backend environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendJobCmdlet.JobId"> <summary> <para> <para>The ID for the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendJobCmdlet.Operation"> <summary> <para> <para>Filters the list of response objects to include only those with the specified operation name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendJobCmdlet.Status"> <summary> <para> <para>Filters the list of response objects to include only those with the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.UpdateBackendJobResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.UpdateBackendJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMPB.UpdateAMPBBackendJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |