Skip to content

Commit 7667670

Browse files
authored
feat(aws-android-sdk-cognitoidentityprovider): update models to latest (#2080)
1 parent 607efcb commit 7667670

File tree

140 files changed

+2965
-2123
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

140 files changed

+2965
-2123
lines changed

aws-android-sdk-cognitoidentityprovider/src/main/java/com/amazonaws/services/cognitoidentityprovider/AmazonCognitoIdentityProvider.java

Lines changed: 41 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -194,25 +194,23 @@ AdminConfirmSignUpResult adminConfirmSignUp(AdminConfirmSignUpRequest adminConfi
194194
* If <code>MessageAction</code> is not set, the default is to send a
195195
* welcome message via email or phone (SMS).
196196
* </p>
197-
* <note>
198197
* <p>
199198
* This message is based on a template that you configured in your call to
200-
* or . This template includes your custom sign-up instructions and
201-
* placeholders for user name and temporary password.
199+
* create or update a user pool. This template includes your custom sign-up
200+
* instructions and placeholders for user name and temporary password.
202201
* </p>
203-
* </note>
204202
* <p>
205-
* Alternatively, you can call AdminCreateUser with “SUPPRESS” for the
206-
* <code>MessageAction</code> parameter, and Amazon Cognito will not send
207-
* any email.
203+
* Alternatively, you can call <code>AdminCreateUser</code> with “SUPPRESS”
204+
* for the <code>MessageAction</code> parameter, and Amazon Cognito will not
205+
* send any email.
208206
* </p>
209207
* <p>
210208
* In either case, the user will be in the
211209
* <code>FORCE_CHANGE_PASSWORD</code> state until they sign in and change
212210
* their password.
213211
* </p>
214212
* <p>
215-
* AdminCreateUser requires developer credentials.
213+
* <code>AdminCreateUser</code> requires developer credentials.
216214
* </p>
217215
*
218216
* @param adminCreateUserRequest <p>
@@ -319,7 +317,9 @@ AdminDeleteUserAttributesResult adminDeleteUserAttributes(
319317
* user, any link between that user and an existing user is removed. The
320318
* next time the external user (no longer attached to the previously linked
321319
* <code>DestinationUser</code>) signs in, they must create a new user
322-
* account. See .
320+
* account. See <a href=
321+
* "https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html"
322+
* >AdminLinkProviderForUser</a>.
323323
* </p>
324324
* <p>
325325
* This action is enabled only for admin access and requires developer
@@ -348,12 +348,12 @@ AdminDeleteUserAttributesResult adminDeleteUserAttributes(
348348
* <code>ProviderAttributeName</code> and
349349
* <code>ProviderAttributeValue</code> must be the same values that were
350350
* used for the <code>SourceUser</code> when the identities were originally
351-
* linked in the call. (If the linking was done with
352-
* <code>ProviderAttributeName</code> set to <code>Cognito_Subject</code>,
353-
* the same applies here). However, if the user has already signed in, the
354-
* <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code>
355-
* and <code>ProviderAttributeValue</code> must be the subject of the SAML
356-
* assertion.
351+
* linked using <code> AdminLinkProviderForUser</code> call. (If the linking
352+
* was done with <code>ProviderAttributeName</code> set to
353+
* <code>Cognito_Subject</code>, the same applies here). However, if the
354+
* user has already signed in, the <code>ProviderAttributeName</code> must
355+
* be <code>Cognito_Subject</code> and <code>ProviderAttributeValue</code>
356+
* must be the subject of the SAML assertion.
357357
* </p>
358358
*
359359
* @param adminDisableProviderForUserRequest
@@ -587,7 +587,11 @@ AdminInitiateAuthResult adminInitiateAuth(AdminInitiateAuthRequest adminInitiate
587587
* federated user identity is used, the user signs in as the existing user
588588
* account.
589589
* </p>
590-
* <important>
590+
* <note>
591+
* <p>
592+
* The maximum number of federated identities linked to a user is 5.
593+
* </p>
594+
* </note> <important>
591595
* <p>
592596
* Because this API allows a user with an external federated identity to
593597
* sign in as an existing user in the user pool, it is critical that it only
@@ -596,9 +600,6 @@ AdminInitiateAuthResult adminInitiateAuth(AdminInitiateAuthRequest adminInitiate
596600
* </p>
597601
* </important>
598602
* <p>
599-
* See also .
600-
* </p>
601-
* <p>
602603
* This action is enabled only for admin access and requires developer
603604
* credentials.
604605
* </p>
@@ -613,6 +614,7 @@ AdminInitiateAuthResult adminInitiateAuth(AdminInitiateAuthRequest adminInitiate
613614
* @throws NotAuthorizedException
614615
* @throws UserNotFoundException
615616
* @throws AliasExistsException
617+
* @throws LimitExceededException
616618
* @throws InternalErrorException
617619
* @throws AmazonClientException If any internal errors are encountered
618620
* inside the client while attempting to make the request or
@@ -918,8 +920,9 @@ AdminSetUserPasswordResult adminSetUserPassword(
918920
* <p>
919921
* <i>This action is no longer supported.</i> You can use it to configure
920922
* only SMS MFA. You can't use it to configure TOTP software token MFA. To
921-
* configure either type of MFA, use the <a>AdminSetUserMFAPreference</a>
922-
* action instead.
923+
* configure either type of MFA, use <a href=
924+
* "https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html"
925+
* >AdminSetUserMFAPreference</a> instead.
923926
* </p>
924927
*
925928
* @param adminSetUserSettingsRequest <p>
@@ -1103,6 +1106,7 @@ AdminUserGlobalSignOutResult adminUserGlobalSignOut(
11031106
* @return associateSoftwareTokenResult The response from the
11041107
* AssociateSoftwareToken service method, as returned by Amazon
11051108
* Cognito Your User Pool.
1109+
* @throws ConcurrentModificationException
11061110
* @throws InvalidParameterException
11071111
* @throws NotAuthorizedException
11081112
* @throws ResourceNotFoundException
@@ -1887,11 +1891,14 @@ void forgetDevice(ForgetDeviceRequest forgetDeviceRequest) throws AmazonClientEx
18871891
* confirmation code that is required to change the user's password. For the
18881892
* <code>Username</code> parameter, you can use the username or user alias.
18891893
* The method used to send the confirmation code is sent according to the
1890-
* specified AccountRecoverySetting. For more information, see <a
1891-
* href="">Recovering User Accounts</a> in the <i>Amazon Cognito Developer
1894+
* specified AccountRecoverySetting. For more information, see <a href=
1895+
* "https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html"
1896+
* >Recovering User Accounts</a> in the <i>Amazon Cognito Developer
18921897
* Guide</i>. If neither a verified phone number nor a verified email
18931898
* exists, an <code>InvalidParameterException</code> is thrown. To use the
1894-
* confirmation code for resetting the password, call .
1899+
* confirmation code for resetting the password, call <a href=
1900+
* "https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html"
1901+
* >ConfirmForgotPassword</a>.
18951902
* </p>
18961903
*
18971904
* @param forgotPasswordRequest <p>
@@ -2618,9 +2625,6 @@ RespondToAuthChallengeResult respondToAuthChallenge(
26182625
* to include the <code>UserPoolAddOns</code> key
26192626
* <code>AdvancedSecurityMode</code>.
26202627
* </p>
2621-
* <p>
2622-
* See .
2623-
* </p>
26242628
*
26252629
* @param setRiskConfigurationRequest
26262630
* @return setRiskConfigurationResult The response from the
@@ -2751,8 +2755,9 @@ SetUserPoolMfaConfigResult setUserPoolMfaConfig(
27512755
* <p>
27522756
* <i>This action is no longer supported.</i> You can use it to configure
27532757
* only SMS MFA. You can't use it to configure TOTP software token MFA. To
2754-
* configure either type of MFA, use the <a>SetUserMFAPreference</a> action
2755-
* instead.
2758+
* configure either type of MFA, use <a href=
2759+
* "https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html"
2760+
* >SetUserMFAPreference</a> instead.
27562761
* </p>
27572762
*
27582763
* @param setUserSettingsRequest <p>
@@ -3136,7 +3141,9 @@ UpdateUserAttributesResult updateUserAttributes(
31363141
/**
31373142
* <p>
31383143
* Updates the specified user pool with the specified attributes. You can
3139-
* get a list of the current user pool settings with .
3144+
* get a list of the current user pool settings using <a href=
3145+
* "https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html"
3146+
* >DescribeUserPool</a>.
31403147
* </p>
31413148
* <important>
31423149
* <p>
@@ -3175,7 +3182,10 @@ UpdateUserPoolResult updateUserPool(UpdateUserPoolRequest updateUserPoolRequest)
31753182
/**
31763183
* <p>
31773184
* Updates the specified user pool app client with the specified attributes.
3178-
* You can get a list of the current user pool app client settings with .
3185+
* You can get a list of the current user pool app client settings using <a
3186+
* href=
3187+
* "https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html"
3188+
* >DescribeUserPoolClient</a>.
31793189
* </p>
31803190
* <important>
31813191
* <p>

aws-android-sdk-cognitoidentityprovider/src/main/java/com/amazonaws/services/cognitoidentityprovider/AmazonCognitoIdentityProviderClient.java

Lines changed: 41 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -575,25 +575,23 @@ public AdminConfirmSignUpResult adminConfirmSignUp(
575575
* If <code>MessageAction</code> is not set, the default is to send a
576576
* welcome message via email or phone (SMS).
577577
* </p>
578-
* <note>
579578
* <p>
580579
* This message is based on a template that you configured in your call to
581-
* or . This template includes your custom sign-up instructions and
582-
* placeholders for user name and temporary password.
580+
* create or update a user pool. This template includes your custom sign-up
581+
* instructions and placeholders for user name and temporary password.
583582
* </p>
584-
* </note>
585583
* <p>
586-
* Alternatively, you can call AdminCreateUser with “SUPPRESS” for the
587-
* <code>MessageAction</code> parameter, and Amazon Cognito will not send
588-
* any email.
584+
* Alternatively, you can call <code>AdminCreateUser</code> with “SUPPRESS”
585+
* for the <code>MessageAction</code> parameter, and Amazon Cognito will not
586+
* send any email.
589587
* </p>
590588
* <p>
591589
* In either case, the user will be in the
592590
* <code>FORCE_CHANGE_PASSWORD</code> state until they sign in and change
593591
* their password.
594592
* </p>
595593
* <p>
596-
* AdminCreateUser requires developer credentials.
594+
* <code>AdminCreateUser</code> requires developer credentials.
597595
* </p>
598596
*
599597
* @param adminCreateUserRequest <p>
@@ -774,7 +772,9 @@ public AdminDeleteUserAttributesResult adminDeleteUserAttributes(
774772
* user, any link between that user and an existing user is removed. The
775773
* next time the external user (no longer attached to the previously linked
776774
* <code>DestinationUser</code>) signs in, they must create a new user
777-
* account. See .
775+
* account. See <a href=
776+
* "https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html"
777+
* >AdminLinkProviderForUser</a>.
778778
* </p>
779779
* <p>
780780
* This action is enabled only for admin access and requires developer
@@ -803,12 +803,12 @@ public AdminDeleteUserAttributesResult adminDeleteUserAttributes(
803803
* <code>ProviderAttributeName</code> and
804804
* <code>ProviderAttributeValue</code> must be the same values that were
805805
* used for the <code>SourceUser</code> when the identities were originally
806-
* linked in the call. (If the linking was done with
807-
* <code>ProviderAttributeName</code> set to <code>Cognito_Subject</code>,
808-
* the same applies here). However, if the user has already signed in, the
809-
* <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code>
810-
* and <code>ProviderAttributeValue</code> must be the subject of the SAML
811-
* assertion.
806+
* linked using <code> AdminLinkProviderForUser</code> call. (If the linking
807+
* was done with <code>ProviderAttributeName</code> set to
808+
* <code>Cognito_Subject</code>, the same applies here). However, if the
809+
* user has already signed in, the <code>ProviderAttributeName</code> must
810+
* be <code>Cognito_Subject</code> and <code>ProviderAttributeValue</code>
811+
* must be the subject of the SAML assertion.
812812
* </p>
813813
*
814814
* @param adminDisableProviderForUserRequest
@@ -1223,7 +1223,11 @@ public AdminInitiateAuthResult adminInitiateAuth(
12231223
* federated user identity is used, the user signs in as the existing user
12241224
* account.
12251225
* </p>
1226-
* <important>
1226+
* <note>
1227+
* <p>
1228+
* The maximum number of federated identities linked to a user is 5.
1229+
* </p>
1230+
* </note> <important>
12271231
* <p>
12281232
* Because this API allows a user with an external federated identity to
12291233
* sign in as an existing user in the user pool, it is critical that it only
@@ -1232,9 +1236,6 @@ public AdminInitiateAuthResult adminInitiateAuth(
12321236
* </p>
12331237
* </important>
12341238
* <p>
1235-
* See also .
1236-
* </p>
1237-
* <p>
12381239
* This action is enabled only for admin access and requires developer
12391240
* credentials.
12401241
* </p>
@@ -1249,6 +1250,7 @@ public AdminInitiateAuthResult adminInitiateAuth(
12491250
* @throws NotAuthorizedException
12501251
* @throws UserNotFoundException
12511252
* @throws AliasExistsException
1253+
* @throws LimitExceededException
12521254
* @throws InternalErrorException
12531255
* @throws AmazonClientException If any internal errors are encountered
12541256
* inside the client while attempting to make the request or
@@ -1792,8 +1794,9 @@ public AdminSetUserPasswordResult adminSetUserPassword(
17921794
* <p>
17931795
* <i>This action is no longer supported.</i> You can use it to configure
17941796
* only SMS MFA. You can't use it to configure TOTP software token MFA. To
1795-
* configure either type of MFA, use the <a>AdminSetUserMFAPreference</a>
1796-
* action instead.
1797+
* configure either type of MFA, use <a href=
1798+
* "https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html"
1799+
* >AdminSetUserMFAPreference</a> instead.
17971800
* </p>
17981801
*
17991802
* @param adminSetUserSettingsRequest <p>
@@ -2112,6 +2115,7 @@ public AdminUserGlobalSignOutResult adminUserGlobalSignOut(
21122115
* @return associateSoftwareTokenResult The response from the
21132116
* AssociateSoftwareToken service method, as returned by Amazon
21142117
* Cognito Your User Pool.
2118+
* @throws ConcurrentModificationException
21152119
* @throws InvalidParameterException
21162120
* @throws NotAuthorizedException
21172121
* @throws ResourceNotFoundException
@@ -3607,11 +3611,14 @@ public void forgetDevice(ForgetDeviceRequest forgetDeviceRequest)
36073611
* confirmation code that is required to change the user's password. For the
36083612
* <code>Username</code> parameter, you can use the username or user alias.
36093613
* The method used to send the confirmation code is sent according to the
3610-
* specified AccountRecoverySetting. For more information, see <a
3611-
* href="">Recovering User Accounts</a> in the <i>Amazon Cognito Developer
3614+
* specified AccountRecoverySetting. For more information, see <a href=
3615+
* "https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html"
3616+
* >Recovering User Accounts</a> in the <i>Amazon Cognito Developer
36123617
* Guide</i>. If neither a verified phone number nor a verified email
36133618
* exists, an <code>InvalidParameterException</code> is thrown. To use the
3614-
* confirmation code for resetting the password, call .
3619+
* confirmation code for resetting the password, call <a href=
3620+
* "https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html"
3621+
* >ConfirmForgotPassword</a>.
36153622
* </p>
36163623
*
36173624
* @param forgotPasswordRequest <p>
@@ -4976,9 +4983,6 @@ public RespondToAuthChallengeResult respondToAuthChallenge(
49764983
* to include the <code>UserPoolAddOns</code> key
49774984
* <code>AdvancedSecurityMode</code>.
49784985
* </p>
4979-
* <p>
4980-
* See .
4981-
* </p>
49824986
*
49834987
* @param setRiskConfigurationRequest
49844988
* @return setRiskConfigurationResult The response from the
@@ -5218,8 +5222,9 @@ public SetUserPoolMfaConfigResult setUserPoolMfaConfig(
52185222
* <p>
52195223
* <i>This action is no longer supported.</i> You can use it to configure
52205224
* only SMS MFA. You can't use it to configure TOTP software token MFA. To
5221-
* configure either type of MFA, use the <a>SetUserMFAPreference</a> action
5222-
* instead.
5225+
* configure either type of MFA, use <a href=
5226+
* "https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html"
5227+
* >SetUserMFAPreference</a> instead.
52235228
* </p>
52245229
*
52255230
* @param setUserSettingsRequest <p>
@@ -5925,7 +5930,9 @@ public UpdateUserAttributesResult updateUserAttributes(
59255930
/**
59265931
* <p>
59275932
* Updates the specified user pool with the specified attributes. You can
5928-
* get a list of the current user pool settings with .
5933+
* get a list of the current user pool settings using <a href=
5934+
* "https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html"
5935+
* >DescribeUserPool</a>.
59295936
* </p>
59305937
* <important>
59315938
* <p>
@@ -5990,7 +5997,10 @@ public UpdateUserPoolResult updateUserPool(UpdateUserPoolRequest updateUserPoolR
59905997
/**
59915998
* <p>
59925999
* Updates the specified user pool app client with the specified attributes.
5993-
* You can get a list of the current user pool app client settings with .
6000+
* You can get a list of the current user pool app client settings using <a
6001+
* href=
6002+
* "https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html"
6003+
* >DescribeUserPoolClient</a>.
59946004
* </p>
59956005
* <important>
59966006
* <p>

0 commit comments

Comments
 (0)