Skip to content

Commit 4c79a05

Browse files
author
AWS
committedDec 3, 2020
AmplifyBackend Update: Regular documentation updates.
·
2.15.692.15.39
1 parent 996a0dd commit 4c79a05

File tree

2 files changed

+108
-110
lines changed

2 files changed

+108
-110
lines changed
 

‎.changes/next-release/feature-AmplifyBackend-177cf6a.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AmplifyBackend",
4+
"contributor": "",
5+
"description": "Regular documentation updates."
6+
}

‎services/amplifybackend/src/main/resources/codegen-resources/service-2.json

Lines changed: 102 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@
213213
"documentation": "<p>400 response</p>"
214214
}
215215
],
216-
"documentation": "<p>Generates a one time challenge code to authenticate a user into your Amplify Admin UI.</p>"
216+
"documentation": "<p>Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.</p>"
217217
},
218218
"DeleteBackend": {
219219
"name": "DeleteBackend",
@@ -247,7 +247,7 @@
247247
"documentation": "<p>400 response</p>"
248248
}
249249
],
250-
"documentation": "<p>Removes an existing environment from your Ampify project.</p>"
250+
"documentation": "<p>Removes an existing environment from your Amplify project.</p>"
251251
},
252252
"DeleteBackendAPI": {
253253
"name": "DeleteBackendAPI",
@@ -417,7 +417,7 @@
417417
"documentation": "<p>400 response</p>"
418418
}
419419
],
420-
"documentation": "<p>Provides project level details for your Amplify UI project.</p>"
420+
"documentation": "<p>Provides project-level details for your Amplify UI project.</p>"
421421
},
422422
"GetBackendAPI": {
423423
"name": "GetBackendAPI",
@@ -451,7 +451,7 @@
451451
"documentation": "<p>400 response</p>"
452452
}
453453
],
454-
"documentation": "<p>Gets the details for a backend api.</p>"
454+
"documentation": "<p>Gets the details for a backend API.</p>"
455455
},
456456
"GetBackendAPIModels": {
457457
"name": "GetBackendAPIModels",
@@ -519,7 +519,7 @@
519519
"documentation": "<p>400 response</p>"
520520
}
521521
],
522-
"documentation": "<p>Gets a backend auth details.</p>"
522+
"documentation": "<p>Gets backend auth details.</p>"
523523
},
524524
"GetBackendJob": {
525525
"name": "GetBackendJob",
@@ -689,7 +689,7 @@
689689
"documentation": "<p>400 response</p>"
690690
}
691691
],
692-
"documentation": "<p>Removes the AWS resources required to access the Amplify Admin UI.</p>"
692+
"documentation": "<p>Removes the AWS resources that are required to access the Amplify Admin UI.</p>"
693693
},
694694
"UpdateBackendAPI": {
695695
"name": "UpdateBackendAPI",
@@ -791,7 +791,7 @@
791791
"documentation": "<p>400 response</p>"
792792
}
793793
],
794-
"documentation": "<p>Updates the AWS resources required to access the Amplify Admin UI.</p>"
794+
"documentation": "<p>Updates the AWS resources that are required to access the Amplify Admin UI.</p>"
795795
},
796796
"UpdateBackendJob": {
797797
"name": "UpdateBackendJob",
@@ -842,17 +842,17 @@
842842
"CognitoUserPoolId": {
843843
"shape": "__string",
844844
"locationName": "cognitoUserPoolId",
845-
"documentation": "<p>The Amazon Cognito user pool id, if Amazon Cognito was used as an authentication setting to access your data models.</p>"
845+
"documentation": "<p>The Amazon Cognito user pool ID, if Amazon Cognito is used as an authentication setting to access your data models.</p>"
846846
},
847847
"Description": {
848848
"shape": "__string",
849849
"locationName": "description",
850-
"documentation": "<p>The api key description for API_KEY, if it was used as an authentication mechanism to access your data models.</p>"
850+
"documentation": "<p>The API key description for API_KEY, if it is used as an authentication mechanism to access your data models.</p>"
851851
},
852852
"ExpirationTime": {
853853
"shape": "__double",
854854
"locationName": "expirationTime",
855-
"documentation": "<p>The api key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.</p>"
855+
"documentation": "<p>The API key expiration time for API_KEY, if it is used as an authentication mechanism to access your data models.</p>"
856856
},
857857
"OpenIDAuthTTL": {
858858
"shape": "__string",
@@ -862,7 +862,7 @@
862862
"OpenIDClientId": {
863863
"shape": "__string",
864864
"locationName": "openIDClientId",
865-
"documentation": "<p>The clientID for openID, if openID was used as an authentication setting to access your data models.</p>"
865+
"documentation": "<p>The clientID for openID, if openID is used as an authentication setting to access your data models.</p>"
866866
},
867867
"OpenIDIatTTL": {
868868
"shape": "__string",
@@ -872,12 +872,12 @@
872872
"OpenIDIssueURL": {
873873
"shape": "__string",
874874
"locationName": "openIDIssueURL",
875-
"documentation": "<p>The openID issuer URL, if openID was used as an authentication setting to access your data models.</p>"
875+
"documentation": "<p>The openID issuer URL, if openID is used as an authentication setting to access your data models.</p>"
876876
},
877877
"OpenIDProviderName": {
878878
"shape": "__string",
879879
"locationName": "openIDProviderName",
880-
"documentation": "<p>The open id provider name, if openID was used as an authentication mechanism to access your data models.</p>"
880+
"documentation": "<p>The openID provider name, if openID is used as an authentication mechanism to access your data models.</p>"
881881
}
882882
},
883883
"documentation": "<p>The authentication settings for accessing provisioned data models in your Amplify project.</p>"
@@ -961,7 +961,7 @@
961961
"documentation": "<p>The strategy for conflict resolution.</p>"
962962
}
963963
},
964-
"documentation": "<p>Describes the conflict resolution configuration for your data model configured in your Amplify project.</p>"
964+
"documentation": "<p>Describes the conflict resolution configuration for the data model configured in your Amplify project.</p>"
965965
},
966966
"BackendAPIReqObj": {
967967
"type": "structure",
@@ -988,22 +988,22 @@
988988
"AdditionalAuthTypes": {
989989
"shape": "ListOfBackendAPIAuthType",
990990
"locationName": "additionalAuthTypes",
991-
"documentation": "<p>Addition authentication methods used to interact with your data models.</p>"
991+
"documentation": "<p>Additional authentication methods used to interact with your data models.</p>"
992992
},
993993
"ApiName": {
994994
"shape": "__string",
995995
"locationName": "apiName",
996-
"documentation": "<p>The API name used to interact with the data model, configured as a part of the amplify project.</p>"
996+
"documentation": "<p>The API name used to interact with the data model, configured as a part of the Amplify project.</p>"
997997
},
998998
"ConflictResolution": {
999999
"shape": "BackendAPIConflictResolution",
10001000
"locationName": "conflictResolution",
1001-
"documentation": "<p>The conflict resoultion strategy for your data stored in the data models.</p>"
1001+
"documentation": "<p>The conflict resolution strategy for your data stored in the data models.</p>"
10021002
},
10031003
"DefaultAuthType": {
10041004
"shape": "BackendAPIAuthType",
10051005
"locationName": "defaultAuthType",
1006-
"documentation": "<p>The default authentication type for interacting with the configured data models in your amplify project.</p>"
1006+
"documentation": "<p>The default authentication type for interacting with the configured data models in your Amplify project.</p>"
10071007
},
10081008
"Service": {
10091009
"shape": "__string",
@@ -1013,10 +1013,10 @@
10131013
"TransformSchema": {
10141014
"shape": "__string",
10151015
"locationName": "transformSchema",
1016-
"documentation": "<p>The definition of the data model in the annotated transform of the graphql schema.</p>"
1016+
"documentation": "<p>The definition of the data model in the annotated transform of the GraphQL schema.</p>"
10171017
}
10181018
},
1019-
"documentation": "<p>The resource config for the data model,configured as a part of the Amplify project.</p>"
1019+
"documentation": "<p>The resource configuration for the data model, configured as a part of the Amplify project.</p>"
10201020
},
10211021
"BackendAPIRespObj": {
10221022
"type": "structure",
@@ -1104,15 +1104,15 @@
11041104
"ClientId": {
11051105
"shape": "__string",
11061106
"locationName": "client_id",
1107-
"documentation": "<p>Describes the client_id which can be obtained from the third party social federation provider.</p>"
1107+
"documentation": "<p>Describes the client_id that can be obtained from the third-party social federation provider.</p>"
11081108
},
11091109
"ClientSecret": {
11101110
"shape": "__string",
11111111
"locationName": "client_secret",
1112-
"documentation": "<p>Describes the client_secret which can be obtained from third party social federation providers.</p>"
1112+
"documentation": "<p>Describes the client_secret that can be obtained from third-party social federation providers.</p>"
11131113
}
11141114
},
1115-
"documentation": "<p>Describes third party social federation configurations for allowing your app users to sign in using OAuth.</p>"
1115+
"documentation": "<p>Describes third-party social federation configurations for allowing your app users to sign in using OAuth.</p>"
11161116
},
11171117
"BackendConfigRespObj": {
11181118
"type": "structure",
@@ -1135,7 +1135,7 @@
11351135
"LoginAuthConfig": {
11361136
"shape": "LoginAuthConfigReqObj",
11371137
"locationName": "loginAuthConfig",
1138-
"documentation": "<p>Describes the Amazon Cognito configurations for the Admin UI auth resource to login with.</p>"
1138+
"documentation": "<p>Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.</p>"
11391139
}
11401140
},
11411141
"documentation": "<p>The response object for this operation.</p>"
@@ -1146,12 +1146,12 @@
11461146
"Operation": {
11471147
"shape": "__string",
11481148
"locationName": "operation",
1149-
"documentation": "<p>Filters the list of response objects to only include those with the specified operation name.</p>"
1149+
"documentation": "<p>Filters the list of response objects to include only those with the specified operation name.</p>"
11501150
},
11511151
"Status": {
11521152
"shape": "__string",
11531153
"locationName": "status",
1154-
"documentation": "<p>Filters the list of response objects to only include those with the specified status.</p>"
1154+
"documentation": "<p>Filters the list of response objects to include only those with the specified status.</p>"
11551155
}
11561156
},
11571157
"documentation": "<p>The request object for this operation.</p>"
@@ -1212,7 +1212,7 @@
12121212
"Message": {
12131213
"shape": "__string",
12141214
"locationName": "message",
1215-
"documentation": "<p>An error message to inform that the request has failed.</p>"
1215+
"documentation": "<p>An error message to inform that the request failed.</p>"
12161216
}
12171217
},
12181218
"documentation": "<p>An error returned if a request is not formed properly.</p>",
@@ -1438,7 +1438,7 @@
14381438
"DeliveryMethod": {
14391439
"shape": "DeliveryMethod",
14401440
"locationName": "deliveryMethod",
1441-
"documentation": "<p>Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.</p>"
1441+
"documentation": "<p>Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.</p>"
14421442
},
14431443
"EmailSettings": {
14441444
"shape": "EmailSettings",
@@ -1451,7 +1451,7 @@
14511451
"documentation": "<p>The configuration for the SMS message sent when an app user forgets their password.</p>"
14521452
}
14531453
},
1454-
"documentation": "<p>Describes the forgot password policy for authenticating into the Amlify app.</p>",
1454+
"documentation": "<p>Describes the forgot password policy for authenticating into the Amplify app.</p>",
14551455
"required": [
14561456
"DeliveryMethod"
14571457
]
@@ -1470,7 +1470,7 @@
14701470
"documentation": "<p>Set to true or false based on whether you want to enable guest authorization to your Amplify app.</p>"
14711471
}
14721472
},
1473-
"documentation": "<p>Describes authorization configurations for the auth resources, configures as a part of your Amplify project.</p>",
1473+
"documentation": "<p>Describes authorization configurations for the auth resources, configured as a part of your Amplify project.</p>",
14741474
"required": [
14751475
"UnauthenticatedLogin",
14761476
"IdentityPoolName"
@@ -1481,15 +1481,15 @@
14811481
"members": {
14821482
"MFAMode": {
14831483
"shape": "MFAMode",
1484-
"documentation": "<p>Describes whether MFA should be [ON, OFF, OPTIONAL] for authentication in your Amplify project.</p>"
1484+
"documentation": "<p>Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.</p>"
14851485
},
14861486
"Settings": {
14871487
"shape": "Settings",
14881488
"locationName": "settings",
14891489
"documentation": "<p>Describes the configuration settings and methods for your Amplify app users to use MFA.</p>"
14901490
}
14911491
},
1492-
"documentation": "<p>Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.</p>",
1492+
"documentation": "<p>Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.</p>",
14931493
"required": [
14941494
"MFAMode"
14951495
]
@@ -1505,27 +1505,27 @@
15051505
"OAuthGrantType": {
15061506
"shape": "OAuthGrantType",
15071507
"locationName": "oAuthGrantType",
1508-
"documentation": "<p>The OAuth grant type which you use to allow app users to authenticate from your Amplify app.</p>"
1508+
"documentation": "<p>The OAuth grant type that you use to allow app users to authenticate from your Amplify app.</p>"
15091509
},
15101510
"OAuthScopes": {
15111511
"shape": "ListOfOAuthScopesElement",
15121512
"locationName": "oAuthScopes",
1513-
"documentation": "<p>List of OAuth related flows which use to allow your app users to authenticate from your Amplify app.</p>"
1513+
"documentation": "<p>List of OAuth-related flows that allow your app users to authenticate from your Amplify app.</p>"
15141514
},
15151515
"RedirectSignInURIs": {
15161516
"shape": "ListOf__string",
15171517
"locationName": "redirectSignInURIs",
1518-
"documentation": "<p>The redirected URI for sigining into your Amplify app.</p>"
1518+
"documentation": "<p>The redirected URI for signing in to your Amplify app.</p>"
15191519
},
15201520
"RedirectSignOutURIs": {
15211521
"shape": "ListOf__string",
15221522
"locationName": "redirectSignOutURIs",
1523-
"documentation": "<p>Redirect URLs used by OAuth when a user signs out of an Amplify app.</p>"
1523+
"documentation": "<p>Redirect URLs that OAuth uses when a user signs out of an Amplify app.</p>"
15241524
},
15251525
"SocialProviderSettings": {
15261526
"shape": "SocialProviderSettings",
15271527
"locationName": "socialProviderSettings",
1528-
"documentation": "<p>The settings for using the social providers for access to your Amplify app.</p>"
1528+
"documentation": "<p>The settings for using social identity providers for access to your Amplify app.</p>"
15291529
}
15301530
},
15311531
"documentation": "<p>Creates the OAuth configuration for your Amplify project.</p>",
@@ -1542,15 +1542,15 @@
15421542
"AdditionalConstraints": {
15431543
"shape": "ListOfAdditionalConstraintsElement",
15441544
"locationName": "additionalConstraints",
1545-
"documentation": "<p>Additional constraints for the pasword used to access the backend of your Amplify project.</p>"
1545+
"documentation": "<p>Additional constraints for the password used to access the backend of your Amplify project.</p>"
15461546
},
15471547
"MinimumLength": {
15481548
"shape": "__double",
15491549
"locationName": "minimumLength",
1550-
"documentation": "<p>The minimum length of password used to access the backend of your Amplify project.</p>"
1550+
"documentation": "<p>The minimum length of the password used to access the backend of your Amplify project.</p>"
15511551
}
15521552
},
1553-
"documentation": "<p>The password policy configuration for the backend to your Amplify project.</p>",
1553+
"documentation": "<p>The password policy configuration for the backend of your Amplify project.</p>",
15541554
"required": [
15551555
"MinimumLength"
15561556
]
@@ -1625,7 +1625,7 @@
16251625
"IdentityPoolConfigs": {
16261626
"shape": "CreateBackendAuthIdentityPoolConfig",
16271627
"locationName": "identityPoolConfigs",
1628-
"documentation": "<p>Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.</p>"
1628+
"documentation": "<p>Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of the auth resource in your Amplify project.</p>"
16291629
},
16301630
"Service": {
16311631
"shape": "Service",
@@ -1635,7 +1635,7 @@
16351635
"UserPoolConfigs": {
16361636
"shape": "CreateBackendAuthUserPoolConfig",
16371637
"locationName": "userPoolConfigs",
1638-
"documentation": "<p>Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.</p>"
1638+
"documentation": "<p>Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of the auth resource in your Amplify project.</p>"
16391639
}
16401640
},
16411641
"documentation": "<p>Defines the resource configuration when creating an auth resource in your Amplify project.</p>",
@@ -1691,7 +1691,7 @@
16911691
"Mfa": {
16921692
"shape": "CreateBackendAuthMFAConfig",
16931693
"locationName": "mfa",
1694-
"documentation": "<p>Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.</p>"
1694+
"documentation": "<p>Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.</p>"
16951695
},
16961696
"OAuth": {
16971697
"shape": "CreateBackendAuthOAuthConfig",
@@ -1706,12 +1706,12 @@
17061706
"RequiredSignUpAttributes": {
17071707
"shape": "ListOfRequiredSignUpAttributesElement",
17081708
"locationName": "requiredSignUpAttributes",
1709-
"documentation": "<p>The required attributes to sign up new users in the user pool.</p>"
1709+
"documentation": "<p>The required attributes to sign up new users in the Amazon Cognito user pool.</p>"
17101710
},
17111711
"SignInMethod": {
17121712
"shape": "SignInMethod",
17131713
"locationName": "signInMethod",
1714-
"documentation": "<p>Describes the sign-in methods that your Amplify app users to login using the Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
1714+
"documentation": "<p>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.</p>"
17151715
},
17161716
"UserPoolName": {
17171717
"shape": "__string",
@@ -1832,7 +1832,7 @@
18321832
"ResourceConfig": {
18331833
"shape": "ResourceConfig",
18341834
"locationName": "resourceConfig",
1835-
"documentation": "<p>The resource configuration for the create backend request.</p>"
1835+
"documentation": "<p>The resource configuration for the backend creation request.</p>"
18361836
},
18371837
"ResourceName": {
18381838
"shape": "__string",
@@ -1868,7 +1868,7 @@
18681868
"ResourceConfig": {
18691869
"shape": "ResourceConfig",
18701870
"locationName": "resourceConfig",
1871-
"documentation": "<p>The resource configuration for the create backend request.</p>"
1871+
"documentation": "<p>The resource configuration for the backend creation request.</p>"
18721872
},
18731873
"ResourceName": {
18741874
"shape": "__string",
@@ -1983,17 +1983,17 @@
19831983
"ChallengeCode": {
19841984
"shape": "__string",
19851985
"locationName": "challengeCode",
1986-
"documentation": "<p>One time challenge code for authenticating into Amplify Admin UI.</p>"
1986+
"documentation": "<p>One-time challenge code for authenticating into the Amplify Admin UI.</p>"
19871987
},
19881988
"SessionId": {
19891989
"shape": "__string",
19901990
"locationName": "sessionId",
1991-
"documentation": "<p>A unique identifier provided when creating a new challenge token.</p>"
1991+
"documentation": "<p>A unique ID provided when creating a new challenge token.</p>"
19921992
},
19931993
"Ttl": {
19941994
"shape": "__string",
19951995
"locationName": "ttl",
1996-
"documentation": "<p>The expiry time for the one time generated token code.</p>"
1996+
"documentation": "<p>The expiry time for the one-time generated token code.</p>"
19971997
}
19981998
},
19991999
"documentation": "<p>The response object for this operation.</p>",
@@ -2015,17 +2015,17 @@
20152015
"ChallengeCode": {
20162016
"shape": "__string",
20172017
"locationName": "challengeCode",
2018-
"documentation": "<p>One time challenge code for authenticating into Amplify Admin UI.</p>"
2018+
"documentation": "<p>One-time challenge code for authenticating into the Amplify Admin UI.</p>"
20192019
},
20202020
"SessionId": {
20212021
"shape": "__string",
20222022
"locationName": "sessionId",
2023-
"documentation": "<p>A unique identifier provided when creating a new challenge token.</p>"
2023+
"documentation": "<p>A unique ID provided when creating a new challenge token.</p>"
20242024
},
20252025
"Ttl": {
20262026
"shape": "__string",
20272027
"locationName": "ttl",
2028-
"documentation": "<p>The expiry time for the one time generated token code.</p>"
2028+
"documentation": "<p>The expiry time for the one-time generated token code.</p>"
20292029
}
20302030
}
20312031
},
@@ -2269,7 +2269,7 @@
22692269
"shape": "__string",
22702270
"location": "uri",
22712271
"locationName": "sessionId",
2272-
"documentation": "<p>The session Id.</p>"
2272+
"documentation": "<p>The session ID.</p>"
22732273
}
22742274
},
22752275
"required": [
@@ -2330,7 +2330,7 @@
23302330
"Message": {
23312331
"shape": "__string",
23322332
"locationName": "message",
2333-
"documentation": "<p>An error message to inform that the request has failed.</p>"
2333+
"documentation": "<p>An error message to inform that the request failed.</p>"
23342334
}
23352335
},
23362336
"documentation": "<p>An error returned if there's a temporary issue with the service.</p>",
@@ -2408,7 +2408,7 @@
24082408
"Models": {
24092409
"shape": "__string",
24102410
"locationName": "models",
2411-
"documentation": "<p>Stringified JSON of the datastore model.</p>"
2411+
"documentation": "<p>Stringified JSON of the DataStore model.</p>"
24122412
},
24132413
"Status": {
24142414
"shape": "Status",
@@ -2452,7 +2452,7 @@
24522452
"Models": {
24532453
"shape": "__string",
24542454
"locationName": "models",
2455-
"documentation": "<p>Stringified JSON of the datastore model.</p>"
2455+
"documentation": "<p>Stringified JSON of the DataStore model.</p>"
24562456
},
24572457
"Status": {
24582458
"shape": "Status",
@@ -2776,7 +2776,7 @@
27762776
"AmplifyMetaConfig": {
27772777
"shape": "__string",
27782778
"locationName": "amplifyMetaConfig",
2779-
"documentation": "<p>A stringified version of the current configs for your Amplify project.</p>"
2779+
"documentation": "<p>A stringified version of the current configurations for your Amplify project.</p>"
27802780
},
27812781
"AppId": {
27822782
"shape": "__string",
@@ -2815,7 +2815,7 @@
28152815
"AmplifyMetaConfig": {
28162816
"shape": "__string",
28172817
"locationName": "amplifyMetaConfig",
2818-
"documentation": "<p>A stringified version of the current configs for your Amplify project.</p>"
2818+
"documentation": "<p>A stringified version of the current configurations for your Amplify project.</p>"
28192819
},
28202820
"AppId": {
28212821
"shape": "__string",
@@ -2857,7 +2857,7 @@
28572857
"shape": "__string",
28582858
"location": "uri",
28592859
"locationName": "sessionId",
2860-
"documentation": "<p>The session Id.</p>"
2860+
"documentation": "<p>The session ID.</p>"
28612861
}
28622862
},
28632863
"required": [
@@ -2876,17 +2876,17 @@
28762876
"ChallengeCode": {
28772877
"shape": "__string",
28782878
"locationName": "challengeCode",
2879-
"documentation": "<p>The one time challenge code for authenticating into Amplify Admin UI.</p>"
2879+
"documentation": "<p>The one-time challenge code for authenticating into the Amplify Admin UI.</p>"
28802880
},
28812881
"SessionId": {
28822882
"shape": "__string",
28832883
"locationName": "sessionId",
2884-
"documentation": "<p>A unique identifier provided when creating a new challenge token.</p>"
2884+
"documentation": "<p>A unique ID provided when creating a new challenge token.</p>"
28852885
},
28862886
"Ttl": {
28872887
"shape": "__string",
28882888
"locationName": "ttl",
2889-
"documentation": "<p>The expiry time for the one time generated token code.</p>"
2889+
"documentation": "<p>The expiry time for the one-time generated token code.</p>"
28902890
}
28912891
},
28922892
"documentation": "<p>The response object for this operation.</p>",
@@ -2908,17 +2908,17 @@
29082908
"ChallengeCode": {
29092909
"shape": "__string",
29102910
"locationName": "challengeCode",
2911-
"documentation": "<p>The one time challenge code for authenticating into Amplify Admin UI.</p>"
2911+
"documentation": "<p>The one-time challenge code for authenticating into the Amplify Admin UI.</p>"
29122912
},
29132913
"SessionId": {
29142914
"shape": "__string",
29152915
"locationName": "sessionId",
2916-
"documentation": "<p>A unique identifier provided when creating a new challenge token.</p>"
2916+
"documentation": "<p>A unique ID provided when creating a new challenge token.</p>"
29172917
},
29182918
"Ttl": {
29192919
"shape": "__string",
29202920
"locationName": "ttl",
2921-
"documentation": "<p>The expiry time for the one time generated token code.</p>"
2921+
"documentation": "<p>The expiry time for the one-time generated token code.</p>"
29222922
}
29232923
}
29242924
},
@@ -2928,7 +2928,7 @@
29282928
"Message": {
29292929
"shape": "__string",
29302930
"locationName": "message",
2931-
"documentation": "<p>An error message to inform that the request has failed.</p>"
2931+
"documentation": "<p>An error message to inform that the request failed.</p>"
29322932
}
29332933
},
29342934
"documentation": "<p>An error returned if there's a temporary issue with the service.</p>"
@@ -2944,10 +2944,10 @@
29442944
"Message": {
29452945
"shape": "__string",
29462946
"locationName": "message",
2947-
"documentation": "<p>An error message to inform that the request has failed.</p>"
2947+
"documentation": "<p>An error message to inform that the request failed.</p>"
29482948
}
29492949
},
2950-
"documentation": "<p>An error that is returned when a limit of a specific type has been exceeded.</p>"
2950+
"documentation": "<p>An error that is returned when a limit of a specific type is exceeded.</p>"
29512951
},
29522952
"ListBackendJobReqObj": {
29532953
"type": "structure",
@@ -2960,7 +2960,7 @@
29602960
"MaxResults": {
29612961
"shape": "__integerMin1Max25",
29622962
"locationName": "maxResults",
2963-
"documentation": "<p>The maximum number of results you want in the response.</p>"
2963+
"documentation": "<p>The maximum number of results that you want in the response.</p>"
29642964
},
29652965
"NextToken": {
29662966
"shape": "__string",
@@ -2970,12 +2970,12 @@
29702970
"Operation": {
29712971
"shape": "__string",
29722972
"locationName": "operation",
2973-
"documentation": "<p>Filters the list of response objects to only include those with the specified operation name.</p>"
2973+
"documentation": "<p>Filters the list of response objects to include only those with the specified operation name.</p>"
29742974
},
29752975
"Status": {
29762976
"shape": "__string",
29772977
"locationName": "status",
2978-
"documentation": "<p>Filters the list of response objects to only include those with the specified status.</p>"
2978+
"documentation": "<p>Filters the list of response objects to include only those with the specified status.</p>"
29792979
}
29802980
},
29812981
"documentation": "<p>The request object for this operation.</p>"
@@ -3019,7 +3019,7 @@
30193019
"MaxResults": {
30203020
"shape": "__integerMin1Max25",
30213021
"locationName": "maxResults",
3022-
"documentation": "<p>The maximum number of results you want in the response.</p>"
3022+
"documentation": "<p>The maximum number of results that you want in the response.</p>"
30233023
},
30243024
"NextToken": {
30253025
"shape": "__string",
@@ -3029,12 +3029,12 @@
30293029
"Operation": {
30303030
"shape": "__string",
30313031
"locationName": "operation",
3032-
"documentation": "<p>Filters the list of response objects to only include those with the specified operation name.</p>"
3032+
"documentation": "<p>Filters the list of response objects to include only those with the specified operation name.</p>"
30333033
},
30343034
"Status": {
30353035
"shape": "__string",
30363036
"locationName": "status",
3037-
"documentation": "<p>Filters the list of response objects to only include those with the specified status.</p>"
3037+
"documentation": "<p>Filters the list of response objects to include only those with the specified status.</p>"
30383038
}
30393039
},
30403040
"documentation": "<p>The request body for ListBackendJobs.</p>",
@@ -3064,22 +3064,22 @@
30643064
"AwsCognitoIdentityPoolId": {
30653065
"shape": "__string",
30663066
"locationName": "aws_cognito_identity_pool_id",
3067-
"documentation": "<p>Amazon Cognito identitypool id used for the Amplify Admin UI login authorization.</p>"
3067+
"documentation": "<p>The Amazon Cognito identity pool ID used for Amplify Admin UI login authorization.</p>"
30683068
},
30693069
"AwsCognitoRegion": {
30703070
"shape": "__string",
30713071
"locationName": "aws_cognito_region",
3072-
"documentation": "<p>The AWS Region for the the Amplify Admin login.</p>"
3072+
"documentation": "<p>The AWS Region for the Amplify Admin UI login.</p>"
30733073
},
30743074
"AwsUserPoolsId": {
30753075
"shape": "__string",
30763076
"locationName": "aws_user_pools_id",
3077-
"documentation": "<p>The Amazon Cognito userpool id used for Amplify Admin UI login authentication.</p>"
3077+
"documentation": "<p>The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.</p>"
30783078
},
30793079
"AwsUserPoolsWebClientId": {
30803080
"shape": "__string",
30813081
"locationName": "aws_user_pools_web_client_id",
3082-
"documentation": "<p>The web client ID for the Amazon Cognito userpools.</p>"
3082+
"documentation": "<p>The web client ID for the Amazon Cognito user pools.</p>"
30833083
}
30843084
},
30853085
"documentation": "<p>The request object for this operation.</p>"
@@ -3107,7 +3107,7 @@
31073107
"Message": {
31083108
"shape": "__string",
31093109
"locationName": "message",
3110-
"documentation": "<p>An error message to inform that the request has failed.</p>"
3110+
"documentation": "<p>An error message to inform that the request failed.</p>"
31113111
},
31123112
"ResourceType": {
31133113
"shape": "__string",
@@ -3298,7 +3298,7 @@
32983298
"MfaTypes": {
32993299
"shape": "ListOfMfaTypesElement",
33003300
"locationName": "mfaTypes",
3301-
"documentation": "<p>The supported MFA types</p>"
3301+
"documentation": "<p>The supported MFA types.</p>"
33023302
},
33033303
"SmsMessage": {
33043304
"shape": "__string",
@@ -3341,7 +3341,7 @@
33413341
"shape": "BackendAuthSocialProviderConfig"
33423342
}
33433343
},
3344-
"documentation": "<p>The settings for using the social providers for access to your Amplify app.</p>"
3344+
"documentation": "<p>The settings for using the social identity providers for access to your Amplify app.</p>"
33453345
},
33463346
"Status": {
33473347
"type": "string",
@@ -3361,10 +3361,10 @@
33613361
"Message": {
33623362
"shape": "__string",
33633363
"locationName": "message",
3364-
"documentation": "<p>An error message to inform that the request has failed.</p>"
3364+
"documentation": "<p>An error message to inform that the request failed.</p>"
33653365
}
33663366
},
3367-
"documentation": "<p>An error that is returned when a limit of a specific type has been exceeded.</p>",
3367+
"documentation": "<p>An error that is returned when a limit of a specific type is exceeded.</p>",
33683368
"exception": true,
33693369
"error": {
33703370
"httpStatusCode": 429
@@ -3444,7 +3444,7 @@
34443444
"DeliveryMethod": {
34453445
"shape": "DeliveryMethod",
34463446
"locationName": "deliveryMethod",
3447-
"documentation": "<p>Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.</p>"
3447+
"documentation": "<p>Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.</p>"
34483448
},
34493449
"EmailSettings": {
34503450
"shape": "EmailSettings",
@@ -3457,15 +3457,15 @@
34573457
"documentation": "<p>The configuration for the SMS message sent when an Amplify app user forgets their password.</p>"
34583458
}
34593459
},
3460-
"documentation": "<p>Describes the forgot password policy for authenticating into the Amlify app.</p>"
3460+
"documentation": "<p>Describes the forgot password policy for authenticating into the Amplify app.</p>"
34613461
},
34623462
"UpdateBackendAuthIdentityPoolConfig": {
34633463
"type": "structure",
34643464
"members": {
34653465
"UnauthenticatedLogin": {
34663466
"shape": "__boolean",
34673467
"locationName": "unauthenticatedLogin",
3468-
"documentation": "<p>A boolean value which can be set to allow or disallow guest level authorization into your Amplify app.</p>"
3468+
"documentation": "<p>A Boolean value that you can set to allow or disallow guest-level authorization into your Amplify app.</p>"
34693469
}
34703470
},
34713471
"documentation": "<p>Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.</p>"
@@ -3501,22 +3501,22 @@
35013501
"OAuthScopes": {
35023502
"shape": "ListOfOAuthScopesElement",
35033503
"locationName": "oAuthScopes",
3504-
"documentation": "<p>The list of OAuth related flows which can allow users to authenticate from your Amplify app.</p>"
3504+
"documentation": "<p>The list of OAuth-related flows that can allow users to authenticate from your Amplify app.</p>"
35053505
},
35063506
"RedirectSignInURIs": {
35073507
"shape": "ListOf__string",
35083508
"locationName": "redirectSignInURIs",
3509-
"documentation": "<p>Redirect URLs used by OAuth when a user signs in to an Amplify app.</p>"
3509+
"documentation": "<p>Redirect URLs that OAuth uses when a user signs in to an Amplify app.</p>"
35103510
},
35113511
"RedirectSignOutURIs": {
35123512
"shape": "ListOf__string",
35133513
"locationName": "redirectSignOutURIs",
3514-
"documentation": "<p>Redirect URLs used by OAuth when a user signs out of an Amplify app.</p>"
3514+
"documentation": "<p>Redirect URLs that OAuth uses when a user signs out of an Amplify app.</p>"
35153515
},
35163516
"SocialProviderSettings": {
35173517
"shape": "SocialProviderSettings",
35183518
"locationName": "socialProviderSettings",
3519-
"documentation": "<p>Describes third party social federation configurations for allowing your users to sign in with OAuth.</p>"
3519+
"documentation": "<p>Describes third-party social federation configurations for allowing your users to sign in with OAuth.</p>"
35203520
}
35213521
},
35223522
"documentation": "<p>The OAuth configurations for authenticating users into your Amplify app.</p>"
@@ -3527,15 +3527,15 @@
35273527
"AdditionalConstraints": {
35283528
"shape": "ListOfAdditionalConstraintsElement",
35293529
"locationName": "additionalConstraints",
3530-
"documentation": "<p>Describes additional constrains on password requirements to sign in into the auth resource, configured as a part of your Ampify project.</p>"
3530+
"documentation": "<p>Describes additional constrains on the password requirements to sign in to the auth resource, configured as a part of your Amplify project.</p>"
35313531
},
35323532
"MinimumLength": {
35333533
"shape": "__double",
35343534
"locationName": "minimumLength",
3535-
"documentation": "<p>Describes the minimum length of password required to sign in into the auth resource, configured as a part of your Ampify project.</p>"
3535+
"documentation": "<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>"
35363536
}
35373537
},
3538-
"documentation": "<p>Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.</p>"
3538+
"documentation": "<p>Describes the password policy for your Amazon Cognito user pool that's configured as a part of your Amplify project.</p>"
35393539
},
35403540
"UpdateBackendAuthReqObj": {
35413541
"type": "structure",
@@ -3602,7 +3602,7 @@
36023602
"IdentityPoolConfigs": {
36033603
"shape": "UpdateBackendAuthIdentityPoolConfig",
36043604
"locationName": "identityPoolConfigs",
3605-
"documentation": "<p>Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.</p>"
3605+
"documentation": "<p>Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of the auth resource in your Amplify project.</p>"
36063606
},
36073607
"Service": {
36083608
"shape": "Service",
@@ -3612,7 +3612,7 @@
36123612
"UserPoolConfigs": {
36133613
"shape": "UpdateBackendAuthUserPoolConfig",
36143614
"locationName": "userPoolConfigs",
3615-
"documentation": "<p>Describes the authentication configuration for the Amazon Cognito userpool, provisioned as a part of your auth resource in the Amplify project.</p>"
3615+
"documentation": "<p>Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of the auth resource in your Amplify project.</p>"
36163616
}
36173617
},
36183618
"documentation": "<p>Defines the resource configuration when updating an authentication resource in your Amplify project.</p>",
@@ -3668,7 +3668,7 @@
36683668
"Mfa": {
36693669
"shape": "UpdateBackendAuthMFAConfig",
36703670
"locationName": "mfa",
3671-
"documentation": "<p>Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.</p>"
3671+
"documentation": "<p>Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.</p>"
36723672
},
36733673
"OAuth": {
36743674
"shape": "UpdateBackendAuthOAuthConfig",
@@ -3681,7 +3681,7 @@
36813681
"documentation": "<p>Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
36823682
}
36833683
},
3684-
"documentation": "<p>Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.</p>"
3684+
"documentation": "<p>Describes the Amazon Cognito user pool configuration to configure the authorization resource for your Amplify project on an update.</p>"
36853685
},
36863686
"UpdateBackendConfigReqObj": {
36873687
"type": "structure",
@@ -3735,7 +3735,7 @@
37353735
"LoginAuthConfig": {
37363736
"shape": "LoginAuthConfigReqObj",
37373737
"locationName": "loginAuthConfig",
3738-
"documentation": "<p>Describes the Amazon Cognito configurations for the Admin UI auth resource to login with.</p>"
3738+
"documentation": "<p>Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.</p>"
37393739
}
37403740
}
37413741
},
@@ -3763,12 +3763,12 @@
37633763
"Operation": {
37643764
"shape": "__string",
37653765
"locationName": "operation",
3766-
"documentation": "<p>Filters the list of response objects to only include those with the specified operation name.</p>"
3766+
"documentation": "<p>Filters the list of response objects to include only those with the specified operation name.</p>"
37673767
},
37683768
"Status": {
37693769
"shape": "__string",
37703770
"locationName": "status",
3771-
"documentation": "<p>Filters the list of response objects to only include those with the specified status.</p>"
3771+
"documentation": "<p>Filters the list of response objects to include only those with the specified status.</p>"
37723772
}
37733773
},
37743774
"documentation": "<p>The request body for GetBackendJob.</p>",
@@ -3942,13 +3942,5 @@
39423942
"timestampFormat": "unixTimestamp"
39433943
}
39443944
},
3945-
"documentation": "<p>AWS Amplify Admin API</p>",
3946-
"pagination": {
3947-
"ListBackendJobs": {
3948-
"input_token": "NextToken",
3949-
"output_token": "NextToken",
3950-
"limit_key": "MaxResults",
3951-
"result_key": "Jobs"
3952-
}
3953-
}
3945+
"documentation": "<p>AWS Amplify Admin API</p>"
39543946
}

0 commit comments

Comments
 (0)
Please sign in to comment.