github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/amplifybackend/2020-08-11/docs-2.json (about)

     1  {
     2    "version" : "2.0",
     3    "service" : "<p>AWS Amplify Admin API</p>",
     4    "operations" : {
     5      "CloneBackend" : "<p>This operation clones an existing backend.</p>",
     6      "CreateBackend" : "<p>This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.</p>",
     7      "CreateBackendAPI" : "<p>Creates a new backend API resource.</p>",
     8      "CreateBackendAuth" : "<p>Creates a new backend authentication resource.</p>",
     9      "CreateBackendConfig" : "<p>Creates a config object for a backend.</p>",
    10      "CreateToken" : "<p>Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.</p>",
    11      "DeleteBackend" : "<p>Removes an existing environment from your Amplify project.</p>",
    12      "DeleteBackendAPI" : "<p>Deletes an existing backend API resource.</p>",
    13      "DeleteBackendAuth" : "<p>Deletes an existing backend authentication resource.</p>",
    14      "DeleteToken" : "<p>Deletes the challenge token based on the given appId and sessionId.</p>",
    15      "GenerateBackendAPIModels" : "<p>Generates a model schema for an existing backend API resource.</p>",
    16      "GetBackend" : "<p>Provides project-level details for your Amplify UI project.</p>",
    17      "GetBackendAPI" : "<p>Gets the details for a backend API.</p>",
    18      "GetBackendAPIModels" : "<p>Generates a model schema for existing backend API resource.</p>",
    19      "GetBackendAuth" : "<p>Gets a backend auth details.</p>",
    20      "GetBackendJob" : "<p>Returns information about a specific job.</p>",
    21      "GetToken" : "<p>Gets the challenge token based on the given appId and sessionId.</p>",
    22      "ImportBackendAuth" : "<p>Imports an existing backend authentication resource.</p>",
    23      "ListBackendJobs" : "<p>Lists the jobs for the backend of an Amplify app.</p>",
    24      "RemoveAllBackends" : "<p>Removes all backend environments from your Amplify project.</p>",
    25      "RemoveBackendConfig" : "<p>Removes the AWS resources required to access the Amplify Admin UI.</p>",
    26      "UpdateBackendAPI" : "<p>Updates an existing backend API resource.</p>",
    27      "UpdateBackendAuth" : "<p>Updates an existing backend authentication resource.</p>",
    28      "UpdateBackendConfig" : "<p>Updates the AWS resources required to access the Amplify Admin UI.</p>",
    29      "UpdateBackendJob" : "<p>Updates a specific job.</p>"
    30    },
    31    "shapes" : {
    32      "AuthResources" : {
    33        "base" : null,
    34        "refs" : {
    35          "CreateBackendAuthResourceConfig$AuthResources" : "<p>Defines whether you want to configure only authentication or both authentication and authorization settings.</p>",
    36          "UpdateBackendAuthResourceConfig$AuthResources" : "<p>Defines the service name to use when configuring an authentication resource in your Amplify project.</p>"
    37        }
    38      },
    39      "BackendAPIAppSyncAuthSettings" : {
    40        "base" : "<p>The authentication settings for accessing provisioned data models in your Amplify project.</p>",
    41        "refs" : {
    42          "BackendAPIAuthType$Settings" : "<p>Describes settings for the authentication mode.</p>"
    43        }
    44      },
    45      "BackendAPIAuthType" : {
    46        "base" : "<p>Describes the auth types for your configured data models.</p>",
    47        "refs" : {
    48          "BackendAPIResourceConfig$DefaultAuthType" : "<p>The default authentication type for interacting with the configured data models in your Amplify project.</p>",
    49          "ListOfBackendAPIAuthType$member" : null
    50        }
    51      },
    52      "BackendAPICodegenReqObj" : {
    53        "base" : "<p>The request object for this operation.</p>",
    54        "refs" : { }
    55      },
    56      "BackendAPICodegenRespObj" : {
    57        "base" : "<p>The response object sent when a backend is created.</p>",
    58        "refs" : { }
    59      },
    60      "BackendAPIConflictResolution" : {
    61        "base" : "<p>Describes the conflict resolution configuration for your data model configured in your Amplify project.</p>",
    62        "refs" : {
    63          "BackendAPIResourceConfig$ConflictResolution" : "<p>The conflict resolution strategy for your data stored in the data models.</p>"
    64        }
    65      },
    66      "BackendAPIReqObj" : {
    67        "base" : "<p>The request object for this operation.</p>",
    68        "refs" : { }
    69      },
    70      "BackendAPIResourceConfig" : {
    71        "base" : "<p>The resource config for the data model, configured as a part of the Amplify project.</p>",
    72        "refs" : {
    73          "BackendAPIReqObj$ResourceConfig" : "<p>Defines the resource configuration for the data model in your Amplify project.</p>",
    74          "CreateBackendAPIReqObj$ResourceConfig" : "<p>The resource configuration for this request.</p>",
    75          "GetBackendAPIRespObj$ResourceConfig" : "<p>The resource configuration for this response object.</p>"
    76        }
    77      },
    78      "BackendAPIRespObj" : {
    79        "base" : "<p>The response object sent when a backend is created.</p>",
    80        "refs" : { }
    81      },
    82      "BackendAuthAppleProviderConfig" : {
    83        "base" : "<p>Describes Apple social federation configurations for allowing your app users to sign in using OAuth.</p>",
    84        "refs" : {
    85          "SocialProviderSettings$SignInWithApple" : null
    86        }
    87      },
    88      "BackendAuthRespObj" : {
    89        "base" : "<p>The response object for this operation.</p>",
    90        "refs" : { }
    91      },
    92      "BackendAuthSocialProviderConfig" : {
    93        "base" : "<p>Describes third-party social federation configurations for allowing your app users to sign in using OAuth.</p>",
    94        "refs" : {
    95          "SocialProviderSettings$Facebook" : null,
    96          "SocialProviderSettings$Google" : null,
    97          "SocialProviderSettings$LoginWithAmazon" : null
    98        }
    99      },
   100      "BackendConfigRespObj" : {
   101        "base" : "<p>The response object for this operation.</p>",
   102        "refs" : { }
   103      },
   104      "BackendJobReqObj" : {
   105        "base" : "<p>The request object for this operation.</p>",
   106        "refs" : { }
   107      },
   108      "BackendJobRespObj" : {
   109        "base" : "<p>The response object for this operation.</p>",
   110        "refs" : {
   111          "ListOfBackendJobRespObj$member" : null
   112        }
   113      },
   114      "BadRequestException" : {
   115        "base" : "<p>An error returned if a request is not formed properly.</p>",
   116        "refs" : { }
   117      },
   118      "CloneBackendReqObj" : {
   119        "base" : "<p>The request object for this operation.</p>",
   120        "refs" : { }
   121      },
   122      "CloneBackendRespObj" : {
   123        "base" : "<p>The response object sent when a backend is created.</p>",
   124        "refs" : { }
   125      },
   126      "CreateBackendAPIReqObj" : {
   127        "base" : "<p>The request object for this operation.</p>",
   128        "refs" : { }
   129      },
   130      "CreateBackendAuthForgotPasswordConfig" : {
   131        "base" : "<p>Describes the forgot password policy for authenticating into the Amplify app.</p>",
   132        "refs" : {
   133          "CreateBackendAuthUserPoolConfig$ForgotPassword" : "<p>Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
   134        }
   135      },
   136      "CreateBackendAuthIdentityPoolConfig" : {
   137        "base" : "<p>Describes authorization configurations for the auth resources, configured as a part of your Amplify project.</p>",
   138        "refs" : {
   139          "CreateBackendAuthResourceConfig$IdentityPoolConfigs" : "<p>Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.</p>"
   140        }
   141      },
   142      "CreateBackendAuthMFAConfig" : {
   143        "base" : "<p>Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.</p>",
   144        "refs" : {
   145          "CreateBackendAuthUserPoolConfig$Mfa" : "<p>Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.</p>"
   146        }
   147      },
   148      "CreateBackendAuthOAuthConfig" : {
   149        "base" : "<p>Creates the OAuth configuration for your Amplify project.</p>",
   150        "refs" : {
   151          "CreateBackendAuthUserPoolConfig$OAuth" : "<p>Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
   152        }
   153      },
   154      "CreateBackendAuthPasswordPolicyConfig" : {
   155        "base" : "<p>The password policy configuration for the backend to your Amplify project.</p>",
   156        "refs" : {
   157          "CreateBackendAuthUserPoolConfig$PasswordPolicy" : "<p>Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
   158        }
   159      },
   160      "CreateBackendAuthReqObj" : {
   161        "base" : "<p>The request object for this operation.</p>",
   162        "refs" : { }
   163      },
   164      "CreateBackendAuthResourceConfig" : {
   165        "base" : "<p>Defines the resource configuration when creating an auth resource in your Amplify project.</p>",
   166        "refs" : {
   167          "CreateBackendAuthReqObj$ResourceConfig" : "<p>The resource configuration for this request object.</p>",
   168          "GetBackendAuthRespObj$ResourceConfig" : "<p>The resource configuration for authorization requests to the backend of your Amplify project.</p>"
   169        }
   170      },
   171      "CreateBackendAuthUserPoolConfig" : {
   172        "base" : "<p>Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.</p>",
   173        "refs" : {
   174          "CreateBackendAuthResourceConfig$UserPoolConfigs" : "<p>Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.</p>"
   175        }
   176      },
   177      "CreateBackendConfigReqObj" : {
   178        "base" : "<p>The request object for this operation.</p>",
   179        "refs" : { }
   180      },
   181      "CreateBackendConfigRespObj" : {
   182        "base" : "<p>The response object for this operation.</p>",
   183        "refs" : { }
   184      },
   185      "CreateBackendReqObj" : {
   186        "base" : "<p>The request object for this operation.</p>",
   187        "refs" : { }
   188      },
   189      "CreateBackendRespObj" : {
   190        "base" : "<p>The response object sent when a backend is created.</p>",
   191        "refs" : { }
   192      },
   193      "CreateTokenRespObj" : {
   194        "base" : "<p>The response object for this operation.</p>",
   195        "refs" : { }
   196      },
   197      "DeleteBackendRespObj" : {
   198        "base" : "<p>The returned object for a request to delete a backend.</p>",
   199        "refs" : { }
   200      },
   201      "DeleteTokenRespObj" : {
   202        "base" : "<p>The response object for this operation.</p>",
   203        "refs" : { }
   204      },
   205      "DeliveryMethod" : {
   206        "base" : null,
   207        "refs" : {
   208          "CreateBackendAuthForgotPasswordConfig$DeliveryMethod" : "<p>Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.</p>",
   209          "UpdateBackendAuthForgotPasswordConfig$DeliveryMethod" : "<p>Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.</p>"
   210        }
   211      },
   212      "EmailSettings" : {
   213        "base" : null,
   214        "refs" : {
   215          "CreateBackendAuthForgotPasswordConfig$EmailSettings" : "<p>The configuration for the email sent when an app user forgets their password.</p>",
   216          "UpdateBackendAuthForgotPasswordConfig$EmailSettings" : "<p>The configuration for the email sent when an app user forgets their password.</p>"
   217        }
   218      },
   219      "GatewayTimeoutException" : {
   220        "base" : "<p>An error returned if there's a temporary issue with the service.</p>",
   221        "refs" : { }
   222      },
   223      "GetBackendAPICodegenRespObj" : {
   224        "base" : "<p>The response object for this operation.</p>",
   225        "refs" : { }
   226      },
   227      "GetBackendAPIRespObj" : {
   228        "base" : "<p>The response object for this operation.</p>",
   229        "refs" : { }
   230      },
   231      "GetBackendAuthReqObj" : {
   232        "base" : "<p>The request object for this operation.</p>",
   233        "refs" : { }
   234      },
   235      "GetBackendAuthRespObj" : {
   236        "base" : "<p>The response object for this operation.</p>",
   237        "refs" : { }
   238      },
   239      "GetBackendReqObj" : {
   240        "base" : "<p>The request object for this operation.</p>",
   241        "refs" : { }
   242      },
   243      "GetBackendRespObj" : {
   244        "base" : "<p>The response object for this operation.</p>",
   245        "refs" : { }
   246      },
   247      "GetTokenRespObj" : {
   248        "base" : "<p>The response object for this operation.</p>",
   249        "refs" : { }
   250      },
   251      "ImportBackendAuthReqObj" : {
   252        "base" : "<p>The request object for this operation.</p>",
   253        "refs" : { }
   254      },
   255      "InternalServiceException" : {
   256        "base" : "<p>An error returned if there's a temporary issue with the service.</p>",
   257        "refs" : { }
   258      },
   259      "LimitExceededException" : {
   260        "base" : "<p>An error that is returned when a limit of a specific type has been exceeded.</p>",
   261        "refs" : { }
   262      },
   263      "ListBackendJobReqObj" : {
   264        "base" : "<p>The request object for this operation.</p>",
   265        "refs" : { }
   266      },
   267      "ListBackendJobRespObj" : {
   268        "base" : "<p>The returned list of backend jobs.</p>",
   269        "refs" : { }
   270      },
   271      "LoginAuthConfigReqObj" : {
   272        "base" : "<p>The request object for this operation.</p>",
   273        "refs" : {
   274          "BackendConfigRespObj$LoginAuthConfig" : "<p>Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.</p>",
   275          "UpdateBackendConfigReqObj$LoginAuthConfig" : "<p>Describes the Amazon Cognito configuration for Admin UI access.</p>"
   276        }
   277      },
   278      "MFAMode" : {
   279        "base" : null,
   280        "refs" : {
   281          "CreateBackendAuthMFAConfig$MFAMode" : "<p>Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.</p>",
   282          "UpdateBackendAuthMFAConfig$MFAMode" : "<p>The MFA mode for the backend of your Amplify project.</p>"
   283        }
   284      },
   285      "Mode" : {
   286        "base" : null,
   287        "refs" : {
   288          "BackendAPIAuthType$Mode" : "<p>Describes the authentication mode.</p>"
   289        }
   290      },
   291      "NotFoundException" : {
   292        "base" : "<p>An error returned when a specific resource type is not found.</p>",
   293        "refs" : { }
   294      },
   295      "OAuthGrantType" : {
   296        "base" : null,
   297        "refs" : {
   298          "CreateBackendAuthOAuthConfig$OAuthGrantType" : "<p>The OAuth grant type that you use to allow app users to authenticate from your Amplify app.</p>",
   299          "UpdateBackendAuthOAuthConfig$OAuthGrantType" : "<p>The OAuth grant type to allow app users to authenticate from your Amplify app.</p>"
   300        }
   301      },
   302      "RemoveAllBackendsReqObj" : {
   303        "base" : "<p>The request object for this operation.</p>",
   304        "refs" : { }
   305      },
   306      "RemoveAllBackendsRespObj" : {
   307        "base" : "<p>The response object for this operation.</p>",
   308        "refs" : { }
   309      },
   310      "RemoveBackendAuthReqObj" : {
   311        "base" : "<p>The request object for this operation.</p>",
   312        "refs" : { }
   313      },
   314      "RemoveBackendConfigRespObj" : {
   315        "base" : "<p>The response object for this operation.</p>",
   316        "refs" : { }
   317      },
   318      "ResolutionStrategy" : {
   319        "base" : null,
   320        "refs" : {
   321          "BackendAPIConflictResolution$ResolutionStrategy" : "<p>The strategy for conflict resolution.</p>"
   322        }
   323      },
   324      "ResourceConfig" : {
   325        "base" : null,
   326        "refs" : {
   327          "CreateBackendReqObj$ResourceConfig" : "<p>The resource configuration for the create backend request.</p>"
   328        }
   329      },
   330      "Service" : {
   331        "base" : null,
   332        "refs" : {
   333          "CreateBackendAuthResourceConfig$Service" : "<p>Defines the service name to use when configuring an authentication resource in your Amplify project.</p>",
   334          "UpdateBackendAuthResourceConfig$Service" : "<p>Defines the service name to use when configuring an authentication resource in your Amplify project.</p>"
   335        }
   336      },
   337      "Settings" : {
   338        "base" : null,
   339        "refs" : {
   340          "CreateBackendAuthMFAConfig$Settings" : "<p>Describes the configuration settings and methods for your Amplify app users to use MFA.</p>",
   341          "UpdateBackendAuthMFAConfig$Settings" : "<p>The settings of your MFA configuration for the backend of your Amplify project.</p>"
   342        }
   343      },
   344      "SignInMethod" : {
   345        "base" : null,
   346        "refs" : {
   347          "CreateBackendAuthUserPoolConfig$SignInMethod" : "<p>Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
   348        }
   349      },
   350      "SmsSettings" : {
   351        "base" : null,
   352        "refs" : {
   353          "CreateBackendAuthForgotPasswordConfig$SmsSettings" : "<p>The configuration for the SMS message sent when an app user forgets their password.</p>",
   354          "UpdateBackendAuthForgotPasswordConfig$SmsSettings" : "<p>The configuration for the SMS message sent when an Amplify app user forgets their password.</p>"
   355        }
   356      },
   357      "SocialProviderSettings" : {
   358        "base" : null,
   359        "refs" : {
   360          "CreateBackendAuthOAuthConfig$SocialProviderSettings" : "<p>The settings for using social providers to access your Amplify app.</p>",
   361          "UpdateBackendAuthOAuthConfig$SocialProviderSettings" : "<p>Describes third-party social federation configurations for allowing your users to sign in with OAuth.</p>"
   362        }
   363      },
   364      "Status" : {
   365        "base" : null,
   366        "refs" : {
   367          "GetBackendAPICodegenRespObj$Status" : "<p>The current status of the request.</p>"
   368        }
   369      },
   370      "TooManyRequestsException" : {
   371        "base" : "<p>An error that is returned when a limit of a specific type has been exceeded.</p>",
   372        "refs" : { }
   373      },
   374      "UpdateBackendAuthForgotPasswordConfig" : {
   375        "base" : "<p>Describes the forgot password policy for authenticating into the Amplify app.</p>",
   376        "refs" : {
   377          "UpdateBackendAuthUserPoolConfig$ForgotPassword" : "<p>Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
   378        }
   379      },
   380      "UpdateBackendAuthIdentityPoolConfig" : {
   381        "base" : "<p>Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.</p>",
   382        "refs" : {
   383          "UpdateBackendAuthResourceConfig$IdentityPoolConfigs" : "<p>Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.</p>"
   384        }
   385      },
   386      "UpdateBackendAuthMFAConfig" : {
   387        "base" : "<p>Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.</p>",
   388        "refs" : {
   389          "UpdateBackendAuthUserPoolConfig$Mfa" : "<p>Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.</p>"
   390        }
   391      },
   392      "UpdateBackendAuthOAuthConfig" : {
   393        "base" : "<p>The OAuth configurations for authenticating users into your Amplify app.</p>",
   394        "refs" : {
   395          "UpdateBackendAuthUserPoolConfig$OAuth" : "<p>Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
   396        }
   397      },
   398      "UpdateBackendAuthPasswordPolicyConfig" : {
   399        "base" : "<p>Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.</p>",
   400        "refs" : {
   401          "UpdateBackendAuthUserPoolConfig$PasswordPolicy" : "<p>Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
   402        }
   403      },
   404      "UpdateBackendAuthReqObj" : {
   405        "base" : "<p>The request object for this operation.</p>",
   406        "refs" : { }
   407      },
   408      "UpdateBackendAuthResourceConfig" : {
   409        "base" : "<p>Defines the resource configuration when updating an authentication resource in your Amplify project.</p>",
   410        "refs" : {
   411          "UpdateBackendAuthReqObj$ResourceConfig" : "<p>The resource configuration for this request object.</p>"
   412        }
   413      },
   414      "UpdateBackendAuthUserPoolConfig" : {
   415        "base" : "<p>Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.</p>",
   416        "refs" : {
   417          "UpdateBackendAuthResourceConfig$UserPoolConfigs" : "<p>Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.</p>"
   418        }
   419      },
   420      "UpdateBackendConfigReqObj" : {
   421        "base" : "<p>The request object for this operation.</p>",
   422        "refs" : { }
   423      },
   424      "AdditionalConstraintsElement" : {
   425        "base" : null,
   426        "refs" : {
   427          "ListOfAdditionalConstraintsElement$member" : null
   428        }
   429      },
   430      "MfaTypesElement" : {
   431        "base" : null,
   432        "refs" : {
   433          "ListOfMfaTypesElement$member" : null
   434        }
   435      },
   436      "OAuthScopesElement" : {
   437        "base" : null,
   438        "refs" : {
   439          "ListOfOAuthScopesElement$member" : null
   440        }
   441      },
   442      "RequiredSignUpAttributesElement" : {
   443        "base" : null,
   444        "refs" : {
   445          "ListOfRequiredSignUpAttributesElement$member" : null
   446        }
   447      },
   448      "__boolean" : {
   449        "base" : null,
   450        "refs" : {
   451          "CreateBackendAuthIdentityPoolConfig$UnauthenticatedLogin" : "<p>Set to true or false based on whether you want to enable guest authorization to your Amplify app.</p>",
   452          "DeleteTokenRespObj$IsSuccess" : "<p>Indicates whether the request succeeded or failed.</p>",
   453          "RemoveAllBackendsReqObj$CleanAmplifyApp" : "<p>Cleans up the Amplify Console app if this value is set to true.</p>",
   454          "UpdateBackendAuthIdentityPoolConfig$UnauthenticatedLogin" : "<p>A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.</p>"
   455        }
   456      },
   457      "__double" : {
   458        "base" : null,
   459        "refs" : {
   460          "BackendAPIAppSyncAuthSettings$ExpirationTime" : "<p>The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.</p>",
   461          "CreateBackendAuthPasswordPolicyConfig$MinimumLength" : "<p>The minimum length of the password used to access the backend of your Amplify project.</p>",
   462          "UpdateBackendAuthPasswordPolicyConfig$MinimumLength" : "<p>Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.</p>"
   463        }
   464      },
   465      "__integerMin1Max25" : {
   466        "base" : null,
   467        "refs" : {
   468          "ListBackendJobReqObj$MaxResults" : "<p>The maximum number of results that you want in the response.</p>"
   469        }
   470      },
   471      "ListOfBackendAPIAuthType" : {
   472        "base" : null,
   473        "refs" : {
   474          "BackendAPIResourceConfig$AdditionalAuthTypes" : "<p>Additional authentication methods used to interact with your data models.</p>"
   475        }
   476      },
   477      "ListOfBackendJobRespObj" : {
   478        "base" : null,
   479        "refs" : {
   480          "ListBackendJobRespObj$Jobs" : "<p>An array of jobs and their properties.</p>"
   481        }
   482      },
   483      "ListOfAdditionalConstraintsElement" : {
   484        "base" : null,
   485        "refs" : {
   486          "CreateBackendAuthPasswordPolicyConfig$AdditionalConstraints" : "<p>Additional constraints for the password used to access the backend of your Amplify project.</p>",
   487          "UpdateBackendAuthPasswordPolicyConfig$AdditionalConstraints" : "<p>Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.</p>"
   488        }
   489      },
   490      "ListOfMfaTypesElement" : {
   491        "base" : null,
   492        "refs" : {
   493          "Settings$MfaTypes" : null
   494        }
   495      },
   496      "ListOfOAuthScopesElement" : {
   497        "base" : null,
   498        "refs" : {
   499          "CreateBackendAuthOAuthConfig$OAuthScopes" : "<p>List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.</p>",
   500          "UpdateBackendAuthOAuthConfig$OAuthScopes" : "<p>The list of OAuth-related flows that can allow users to authenticate from your Amplify app.</p>"
   501        }
   502      },
   503      "ListOfRequiredSignUpAttributesElement" : {
   504        "base" : null,
   505        "refs" : {
   506          "CreateBackendAuthUserPoolConfig$RequiredSignUpAttributes" : "<p>The required attributes to sign up new users in the user pool.</p>"
   507        }
   508      },
   509      "ListOf__string" : {
   510        "base" : null,
   511        "refs" : {
   512          "CreateBackendAuthOAuthConfig$RedirectSignInURIs" : "<p>The redirected URI for signing in to your Amplify app.</p>",
   513          "CreateBackendAuthOAuthConfig$RedirectSignOutURIs" : "<p>Redirect URLs that OAuth uses when a user signs out of an Amplify app.</p>",
   514          "GetBackendRespObj$BackendEnvironmentList" : "<p>A list of backend environments in an array.</p>",
   515          "UpdateBackendAuthOAuthConfig$RedirectSignInURIs" : "<p>Redirect URLs that OAuth uses when a user signs in to an Amplify app.</p>",
   516          "UpdateBackendAuthOAuthConfig$RedirectSignOutURIs" : "<p>Redirect URLs that OAuth uses when a user signs out of an Amplify app.</p>"
   517        }
   518      },
   519      "__string" : {
   520        "base" : null,
   521        "refs" : {
   522          "BackendAPIAppSyncAuthSettings$CognitoUserPoolId" : "<p>The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.</p>",
   523          "BackendAPIAppSyncAuthSettings$Description" : "<p>The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.</p>",
   524          "BackendAPIAppSyncAuthSettings$OpenIDAuthTTL" : "<p>The expiry time for the OpenID authentication mechanism.</p>",
   525          "BackendAPIAppSyncAuthSettings$OpenIDClientId" : "<p>The clientID for openID, if openID was used as an authentication setting to access your data models.</p>",
   526          "BackendAPIAppSyncAuthSettings$OpenIDIatTTL" : "<p>The expiry time for the OpenID authentication mechanism.</p>",
   527          "BackendAPIAppSyncAuthSettings$OpenIDIssueURL" : "<p>The openID issuer URL, if openID was used as an authentication setting to access your data models.</p>",
   528          "BackendAPIAppSyncAuthSettings$OpenIDProviderName" : "<p>The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.</p>",
   529          "BackendAPICodegenReqObj$ResourceName" : "<p>The name of this resource.</p>",
   530          "BackendAPICodegenRespObj$AppId" : "<p>The app ID.</p>",
   531          "BackendAPICodegenRespObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   532          "BackendAPICodegenRespObj$Error" : "<p>If the request fails, this error is returned.</p>",
   533          "BackendAPICodegenRespObj$JobId" : "<p>The ID for the job.</p>",
   534          "BackendAPICodegenRespObj$Operation" : "<p>The name of the operation.</p>",
   535          "BackendAPICodegenRespObj$Status" : "<p>The current status of the request.</p>",
   536          "BackendAPIReqObj$ResourceName" : "<p>The name of this resource.</p>",
   537          "BackendAPIResourceConfig$ApiName" : "<p>The API name used to interact with the data model, configured as a part of your Amplify project.</p>",
   538          "BackendAPIResourceConfig$Service" : "<p>The service used to provision and interact with the data model.</p>",
   539          "BackendAPIResourceConfig$TransformSchema" : "<p>The definition of the data model in the annotated transform of the GraphQL schema.</p>",
   540          "BackendAPIRespObj$AppId" : "<p>The app ID.</p>",
   541          "BackendAPIRespObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   542          "BackendAPIRespObj$Error" : "<p>If the request fails, this error is returned.</p>",
   543          "BackendAPIRespObj$JobId" : "<p>The ID for the job.</p>",
   544          "BackendAPIRespObj$Operation" : "<p>The name of the operation.</p>",
   545          "BackendAPIRespObj$Status" : "<p>The current status of the request.</p>",
   546          "BackendAuthAppleProviderConfig$ClientId" : "<p>Describes the client_id (also called Services ID) that comes from Apple.</p>",
   547          "BackendAuthAppleProviderConfig$KeyId" : "<p>Describes the key_id that comes from Apple.</p>",
   548          "BackendAuthAppleProviderConfig$PrivateKey" : "<p>Describes the private_key that comes from Apple.</p>",
   549          "BackendAuthAppleProviderConfig$TeamId" : "<p>Describes the team_id that comes from Apple.</p>",
   550          "BackendAuthRespObj$AppId" : "<p>The app ID.</p>",
   551          "BackendAuthRespObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   552          "BackendAuthRespObj$Error" : "<p>If the request fails, this error is returned.</p>",
   553          "BackendAuthRespObj$JobId" : "<p>The ID for the job.</p>",
   554          "BackendAuthRespObj$Operation" : "<p>The name of the operation.</p>",
   555          "BackendAuthRespObj$Status" : "<p>The current status of the request.</p>",
   556          "BackendAuthSocialProviderConfig$ClientId" : "<p>Describes the client_id, which can be obtained from the third-party social federation provider.</p>",
   557          "BackendAuthSocialProviderConfig$ClientSecret" : "<p>Describes the client_secret, which can be obtained from third-party social federation providers.</p>",
   558          "BackendConfigRespObj$AppId" : "<p>The app ID.</p>",
   559          "BackendConfigRespObj$BackendManagerAppId" : "<p>The app ID for the backend manager.</p>",
   560          "BackendConfigRespObj$Error" : "<p>If the request fails, this error is returned.</p>",
   561          "BackendJobReqObj$Operation" : "<p>Filters the list of response objects to include only those with the specified operation name.</p>",
   562          "BackendJobReqObj$Status" : "<p>Filters the list of response objects to include only those with the specified status.</p>",
   563          "BackendJobRespObj$AppId" : "<p>The app ID.</p>",
   564          "BackendJobRespObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   565          "BackendJobRespObj$CreateTime" : "<p>The time when the job was created.</p>",
   566          "BackendJobRespObj$Error" : "<p>If the request fails, this error is returned.</p>",
   567          "BackendJobRespObj$JobId" : "<p>The ID for the job.</p>",
   568          "BackendJobRespObj$Operation" : "<p>The name of the operation.</p>",
   569          "BackendJobRespObj$Status" : "<p>The current status of the request.</p>",
   570          "BackendJobRespObj$UpdateTime" : "<p>The time when the job was last updated.</p>",
   571          "BadRequestException$Message" : "<p>An error message to inform that the request failed.</p>",
   572          "CloneBackendReqObj$TargetEnvironmentName" : "<p>The name of the destination backend environment to be created.</p>",
   573          "CloneBackendRespObj$AppId" : "<p>The app ID.</p>",
   574          "CloneBackendRespObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   575          "CloneBackendRespObj$Error" : "<p>If the request fails, this error is returned.</p>",
   576          "CloneBackendRespObj$JobId" : "<p>The ID for the job.</p>",
   577          "CloneBackendRespObj$Operation" : "<p>The name of the operation.</p>",
   578          "CloneBackendRespObj$Status" : "<p>The current status of the request.</p>",
   579          "CreateBackendAPIReqObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   580          "CreateBackendAPIReqObj$ResourceName" : "<p>The name of this resource.</p>",
   581          "CreateBackendAuthIdentityPoolConfig$IdentityPoolName" : "<p>Name of the Amazon Cognito identity pool used for authorization.</p>",
   582          "CreateBackendAuthOAuthConfig$DomainPrefix" : "<p>The domain prefix for your Amplify app.</p>",
   583          "CreateBackendAuthReqObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   584          "CreateBackendAuthReqObj$ResourceName" : "<p>The name of this resource.</p>",
   585          "CreateBackendAuthUserPoolConfig$UserPoolName" : "<p>The Amazon Cognito user pool name.</p>",
   586          "CreateBackendConfigReqObj$BackendManagerAppId" : "<p>The app ID for the backend manager.</p>",
   587          "CreateBackendConfigRespObj$AppId" : "<p>The app ID.</p>",
   588          "CreateBackendConfigRespObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   589          "CreateBackendConfigRespObj$JobId" : "<p>The ID for the job.</p>",
   590          "CreateBackendConfigRespObj$Status" : "<p>The current status of the request.</p>",
   591          "CreateBackendReqObj$AppId" : "<p>The app ID.</p>",
   592          "CreateBackendReqObj$AppName" : "<p>The name of the app.</p>",
   593          "CreateBackendReqObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   594          "CreateBackendReqObj$ResourceName" : "<p>The name of the resource.</p>",
   595          "CreateBackendRespObj$AppId" : "<p>The app ID.</p>",
   596          "CreateBackendRespObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   597          "CreateBackendRespObj$Error" : "<p>If the request fails, this error is returned.</p>",
   598          "CreateBackendRespObj$JobId" : "<p>The ID for the job.</p>",
   599          "CreateBackendRespObj$Operation" : "<p>The name of the operation.</p>",
   600          "CreateBackendRespObj$Status" : "<p>The current status of the request.</p>",
   601          "CreateTokenRespObj$AppId" : "<p>The app ID.</p>",
   602          "CreateTokenRespObj$ChallengeCode" : "<p>One-time challenge code for authenticating into the Amplify Admin UI.</p>",
   603          "CreateTokenRespObj$SessionId" : "<p>A unique ID provided when creating a new challenge token.</p>",
   604          "CreateTokenRespObj$Ttl" : "<p>The expiry time for the one-time generated token code.</p>",
   605          "DeleteBackendRespObj$AppId" : "<p>The app ID.</p>",
   606          "DeleteBackendRespObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   607          "DeleteBackendRespObj$Error" : "<p>If the request fails, this error is returned.</p>",
   608          "DeleteBackendRespObj$JobId" : "<p>The ID for the job.</p>",
   609          "DeleteBackendRespObj$Operation" : "<p>The name of the operation.</p>",
   610          "DeleteBackendRespObj$Status" : "<p>The current status of the request.</p>",
   611          "EmailSettings$EmailMessage" : "<p>The body of the email.</p>",
   612          "EmailSettings$EmailSubject" : "<p>The subject of the email.</p>",
   613          "GetBackendAPICodegenRespObj$Models" : "<p>Stringified JSON of the datastore model.</p>",
   614          "GetBackendAPIRespObj$AppId" : "<p>The app ID.</p>",
   615          "GetBackendAPIRespObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   616          "GetBackendAPIRespObj$Error" : "<p>If the request fails, this error is returned.</p>",
   617          "GetBackendAPIRespObj$ResourceName" : "<p>The name of this resource.</p>",
   618          "GetBackendAuthReqObj$ResourceName" : "<p>The name of this resource.</p>",
   619          "GetBackendAuthRespObj$AppId" : "<p>The app ID.</p>",
   620          "GetBackendAuthRespObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   621          "GetBackendAuthRespObj$Error" : "<p>If the request fails, this error is returned.</p>",
   622          "GetBackendAuthRespObj$ResourceName" : "<p>The name of this resource.</p>",
   623          "GetBackendReqObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   624          "GetBackendRespObj$AmplifyFeatureFlags" : "<p>A stringified version of the cli.json file for your Amplify project.</p>",
   625          "GetBackendRespObj$AmplifyMetaConfig" : "<p>A stringified version of the current configs for your Amplify project.</p>",
   626          "GetBackendRespObj$AppId" : "<p>The app ID.</p>",
   627          "GetBackendRespObj$AppName" : "<p>The name of the app.</p>",
   628          "GetBackendRespObj$BackendEnvironmentName" : "<p>The name of the backend environment.</p>",
   629          "GetBackendRespObj$Error" : "<p>If the request failed, this is the returned error.</p>",
   630          "GetTokenRespObj$AppId" : "<p>The app ID.</p>",
   631          "GetTokenRespObj$ChallengeCode" : "<p>The one-time challenge code for authenticating into the Amplify Admin UI.</p>",
   632          "GetTokenRespObj$SessionId" : "<p>A unique ID provided when creating a new challenge token.</p>",
   633          "GetTokenRespObj$Ttl" : "<p>The expiry time for the one-time generated token code.</p>",
   634          "ImportBackendAuthReqObj$IdentityPoolId" : "<p>The ID of the Amazon Cognito identity pool.</p>",
   635          "ImportBackendAuthReqObj$NativeClientId" : "<p>The ID of the Amazon Cognito native client.</p>",
   636          "ImportBackendAuthReqObj$UserPoolId" : "<p>The ID of the Amazon Cognito user pool.</p>",
   637          "ImportBackendAuthReqObj$WebClientId" : "<p>The ID of the Amazon Cognito web client.</p>",
   638          "InternalServiceException$Message" : "<p>An error message to inform that the request failed.</p>",
   639          "LimitExceededException$LimitType" : "<p>The type of limit that was exceeded.</p>",
   640          "LimitExceededException$Message" : "<p>An error message to inform that the request has failed.</p>",
   641          "ListBackendJobReqObj$JobId" : "<p>The ID for the job.</p>",
   642          "ListBackendJobReqObj$NextToken" : "<p>The token for the next set of results.</p>",
   643          "ListBackendJobReqObj$Operation" : "<p>Filters the list of response objects to include only those with the specified operation name.</p>",
   644          "ListBackendJobReqObj$Status" : "<p>Filters the list of response objects to include only those with the specified status.</p>",
   645          "ListBackendJobRespObj$NextToken" : "<p>The token for the next set of results.</p>",
   646          "LoginAuthConfigReqObj$AwsCognitoIdentityPoolId" : "<p>The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.</p>",
   647          "LoginAuthConfigReqObj$AwsCognitoRegion" : "<p>The AWS Region for the Amplify Admin UI login.</p>",
   648          "LoginAuthConfigReqObj$AwsUserPoolsId" : "<p>The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.</p>",
   649          "LoginAuthConfigReqObj$AwsUserPoolsWebClientId" : "<p>The web client ID for the Amazon Cognito user pools.</p>",
   650          "NotFoundException$Message" : "<p>An error message to inform that the request has failed.</p>",
   651          "NotFoundException$ResourceType" : "<p>The type of resource that is not found.</p>",
   652          "RemoveAllBackendsRespObj$AppId" : "<p>The app ID.</p>",
   653          "RemoveAllBackendsRespObj$Error" : "<p>If the request fails, this error is returned.</p>",
   654          "RemoveAllBackendsRespObj$JobId" : "<p>The ID for the job.</p>",
   655          "RemoveAllBackendsRespObj$Operation" : "<p>The name of the operation.</p>",
   656          "RemoveAllBackendsRespObj$Status" : "<p>The current status of the request.</p>",
   657          "RemoveBackendAuthReqObj$ResourceName" : "<p>The name of this resource.</p>",
   658          "RemoveBackendConfigRespObj$Error" : "<p>If the request fails, this error is returned.</p>",
   659          "Settings$SmsMessage" : "<p>The body of the SMS message.</p>",
   660          "SmsSettings$SmsMessage" : "<p>The body of the SMS message.</p>",
   661          "UpdateBackendAuthOAuthConfig$DomainPrefix" : "<p>The Amazon Cognito domain prefix used to create a hosted UI for authentication.</p>",
   662          "UpdateBackendAuthReqObj$ResourceName" : "<p>The name of this resource.</p>",
   663          "ListOf__string$member" : null
   664        }
   665      }
   666    }
   667  }