Skip to content

Commit c654928

Browse files
author
awstools
committed
feat(client-cognito-identity-provider): API model updated in Amazon Cognito
1 parent e0751b4 commit c654928

File tree

57 files changed

+1835
-1978
lines changed

Some content is hidden

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

57 files changed

+1835
-1978
lines changed

Diff for: ‎clients/client-cognito-identity-provider/src/CognitoIdentityProvider.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -2123,8 +2123,8 @@ export interface CognitoIdentityProvider {
21232123
* <p>Using the Amazon Cognito user pools API, you can create a user pool to manage directories and
21242124
* users. You can authenticate a user to obtain tokens related to user identity and access
21252125
* policies.</p>
2126-
* <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
2127-
* <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
2126+
* <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
2127+
* <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
21282128
* Documentation</a>.</p>
21292129
*/
21302130
export class CognitoIdentityProvider extends CognitoIdentityProviderClient implements CognitoIdentityProvider {}

Diff for: ‎clients/client-cognito-identity-provider/src/CognitoIdentityProviderClient.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -702,8 +702,8 @@ export interface CognitoIdentityProviderClientResolvedConfig extends CognitoIden
702702
* <p>Using the Amazon Cognito user pools API, you can create a user pool to manage directories and
703703
* users. You can authenticate a user to obtain tokens related to user identity and access
704704
* policies.</p>
705-
* <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
706-
* <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
705+
* <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
706+
* <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
707707
* Documentation</a>.</p>
708708
*/
709709
export class CognitoIdentityProviderClient extends __Client<

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminAddUserToGroupCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface AdminAddUserToGroupCommandOutput extends __MetadataBearer {}
4242
/**
4343
* @public
4444
* <p>Adds the specified user to the specified group.</p>
45-
* <p>Calling this action requires developer credentials.</p>
45+
* <p>Calling this action requires developer credentials.</p>
4646
* @example
4747
* Use a bare-bones client and the command you need to make an API call.
4848
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminConfirmSignUpCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface AdminConfirmSignUpCommandOutput extends AdminConfirmSignUpRespo
4747
* @public
4848
* <p>Confirms user registration as an admin without using a confirmation code. Works on any
4949
* user.</p>
50-
* <p>Calling this action requires developer credentials.</p>
50+
* <p>Calling this action requires developer credentials.</p>
5151
* @example
5252
* Use a bare-bones client and the command you need to make an API call.
5353
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminCreateUserCommand.ts

+5-7
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,8 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
4747
/**
4848
* @public
4949
* <p>Creates a new user in the specified user pool.</p>
50-
* <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via
50+
* <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via
5151
* email or phone (SMS).</p>
52-
*
5352
* <note>
5453
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
5554
* require you to register an origination phone number before you can send SMS messages
@@ -67,15 +66,14 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
6766
* of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
6867
* Developer Guide</i>.</p>
6968
* </note>
70-
*
71-
* <p>This message is based on a template that you configured in your call to create or
69+
* <p>This message is based on a template that you configured in your call to create or
7270
* update a user pool. This template includes your custom sign-up instructions and
7371
* placeholders for user name and temporary password.</p>
74-
* <p>Alternatively, you can call <code>AdminCreateUser</code> with <code>SUPPRESS</code>
72+
* <p>Alternatively, you can call <code>AdminCreateUser</code> with <code>SUPPRESS</code>
7573
* for the <code>MessageAction</code> parameter, and Amazon Cognito won't send any email. </p>
76-
* <p>In either case, the user will be in the <code>FORCE_CHANGE_PASSWORD</code> state until
74+
* <p>In either case, the user will be in the <code>FORCE_CHANGE_PASSWORD</code> state until
7775
* they sign in and change their password.</p>
78-
* <p>
76+
* <p>
7977
* <code>AdminCreateUser</code> requires developer credentials.</p>
8078
* @example
8179
* Use a bare-bones client and the command you need to make an API call.

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminDeleteUserAttributesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface AdminDeleteUserAttributesCommandOutput extends AdminDeleteUserA
4747
* @public
4848
* <p>Deletes the user attributes in a user pool as an administrator. Works on any
4949
* user.</p>
50-
* <p>Calling this action requires developer credentials.</p>
50+
* <p>Calling this action requires developer credentials.</p>
5151
* @example
5252
* Use a bare-bones client and the command you need to make an API call.
5353
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminDeleteUserCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface AdminDeleteUserCommandOutput extends __MetadataBearer {}
4242
/**
4343
* @public
4444
* <p>Deletes a user as an administrator. Works on any user.</p>
45-
* <p>Calling this action requires developer credentials.</p>
45+
* <p>Calling this action requires developer credentials.</p>
4646
* @example
4747
* Use a bare-bones client and the command you need to make an API call.
4848
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminDisableProviderForUserCommand.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -50,18 +50,18 @@ export interface AdminDisableProviderForUserCommandOutput
5050
* user is removed. When the external user signs in again, and the user is no longer
5151
* attached to the previously linked <code>DestinationUser</code>, the user must create a
5252
* new user account. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a>.</p>
53-
* <p>This action is enabled only for admin access and requires developer
53+
* <p>This action is enabled only for admin access and requires developer
5454
* credentials.</p>
55-
* <p>The <code>ProviderName</code> must match the value specified when creating an IdP for
55+
* <p>The <code>ProviderName</code> must match the value specified when creating an IdP for
5656
* the pool. </p>
57-
* <p>To deactivate a native username + password user, the <code>ProviderName</code> value
57+
* <p>To deactivate a native username + password user, the <code>ProviderName</code> value
5858
* must be <code>Cognito</code> and the <code>ProviderAttributeName</code> must be
5959
* <code>Cognito_Subject</code>. The <code>ProviderAttributeValue</code> must be the
6060
* name that is used in the user pool for the user.</p>
61-
* <p>The <code>ProviderAttributeName</code> must always be <code>Cognito_Subject</code> for
61+
* <p>The <code>ProviderAttributeName</code> must always be <code>Cognito_Subject</code> for
6262
* social IdPs. The <code>ProviderAttributeValue</code> must always be the exact subject
6363
* that was used when the user was originally linked as a source user.</p>
64-
* <p>For de-linking a SAML identity, there are two scenarios. If the linked identity has
64+
* <p>For de-linking a SAML identity, there are two scenarios. If the linked identity has
6565
* not yet been used to sign in, the <code>ProviderAttributeName</code> and
6666
* <code>ProviderAttributeValue</code> must be the same values that were used for the
6767
* <code>SourceUser</code> when the identities were originally linked using <code>

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminDisableUserCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface AdminDisableUserCommandOutput extends AdminDisableUserResponse,
4747
* @public
4848
* <p>Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in,
4949
* but still appears in the responses to <code>GetUser</code> and <code>ListUsers</code> API requests.</p>
50-
* <p>You must make this API request with Amazon Web Services credentials that have <code>cognito-idp:AdminDisableUser</code> permissions.</p>
50+
* <p>You must make this API request with Amazon Web Services credentials that have <code>cognito-idp:AdminDisableUser</code> permissions.</p>
5151
* @example
5252
* Use a bare-bones client and the command you need to make an API call.
5353
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminEnableUserCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface AdminEnableUserCommandOutput extends AdminEnableUserResponse, _
4646
/**
4747
* @public
4848
* <p>Enables the specified user as an administrator. Works on any user.</p>
49-
* <p>Calling this action requires developer credentials.</p>
49+
* <p>Calling this action requires developer credentials.</p>
5050
* @example
5151
* Use a bare-bones client and the command you need to make an API call.
5252
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminForgetDeviceCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface AdminForgetDeviceCommandOutput extends __MetadataBearer {}
4242
/**
4343
* @public
4444
* <p>Forgets the device, as an administrator.</p>
45-
* <p>Calling this action requires developer credentials.</p>
45+
* <p>Calling this action requires developer credentials.</p>
4646
* @example
4747
* Use a bare-bones client and the command you need to make an API call.
4848
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminGetDeviceCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface AdminGetDeviceCommandOutput extends AdminGetDeviceResponse, __M
4747
/**
4848
* @public
4949
* <p>Gets the device, as an administrator.</p>
50-
* <p>Calling this action requires developer credentials.</p>
50+
* <p>Calling this action requires developer credentials.</p>
5151
* @example
5252
* Use a bare-bones client and the command you need to make an API call.
5353
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminGetUserCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export interface AdminGetUserCommandOutput extends AdminGetUserResponse, __Metad
4848
* @public
4949
* <p>Gets the specified user by user name in a user pool as an administrator. Works on any
5050
* user.</p>
51-
* <p>Calling this action requires developer credentials.</p>
51+
* <p>Calling this action requires developer credentials.</p>
5252
* @example
5353
* Use a bare-bones client and the command you need to make an API call.
5454
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminInitiateAuthCommand.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
4747
/**
4848
* @public
4949
* <p>Initiates the authentication flow, as an administrator.</p>
50-
*
5150
* <note>
5251
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
5352
* require you to register an origination phone number before you can send SMS messages
@@ -65,8 +64,7 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
6564
* of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
6665
* Developer Guide</i>.</p>
6766
* </note>
68-
*
69-
* <p>Calling this action requires developer credentials.</p>
67+
* <p>Calling this action requires developer credentials.</p>
7068
* @example
7169
* Use a bare-bones client and the command you need to make an API call.
7270
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminLinkProviderForUserCommand.ts

+6-7
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,18 @@ export interface AdminLinkProviderForUserCommandOutput extends AdminLinkProvider
4747
* user account to an external federated user identity that has not yet been used to sign
4848
* in. You can then use the federated user identity to sign in as the existing user
4949
* account. </p>
50-
* <p> For example, if there is an existing user with a username and password, this API
50+
* <p> For example, if there is an existing user with a username and password, this API
5151
* links that user to a federated user identity. When the user signs in with a federated
5252
* user identity, they sign in as the existing user account.</p>
53-
* <note>
53+
* <note>
5454
* <p>The maximum number of federated identities linked to a user is five.</p>
55-
* </note>
56-
* <important>
55+
* </note>
56+
* <important>
5757
* <p>Because this API allows a user with an external federated identity to sign in as
5858
* an existing user in the user pool, it is critical that it only be used with external
5959
* IdPs and provider attributes that have been trusted by the application owner.</p>
60-
* </important>
61-
*
62-
* <p>This action is administrative and requires developer credentials.</p>
60+
* </important>
61+
* <p>This action is administrative and requires developer credentials.</p>
6362
* @example
6463
* Use a bare-bones client and the command you need to make an API call.
6564
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminListDevicesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface AdminListDevicesCommandOutput extends AdminListDevicesResponse,
4747
/**
4848
* @public
4949
* <p>Lists devices, as an administrator.</p>
50-
* <p>Calling this action requires developer credentials.</p>
50+
* <p>Calling this action requires developer credentials.</p>
5151
* @example
5252
* Use a bare-bones client and the command you need to make an API call.
5353
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminListGroupsForUserCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface AdminListGroupsForUserCommandOutput extends AdminListGroupsForU
4646
/**
4747
* @public
4848
* <p>Lists the groups that the user belongs to.</p>
49-
* <p>Calling this action requires developer credentials.</p>
49+
* <p>Calling this action requires developer credentials.</p>
5050
* @example
5151
* Use a bare-bones client and the command you need to make an API call.
5252
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminRemoveUserFromGroupCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface AdminRemoveUserFromGroupCommandOutput extends __MetadataBearer
4242
/**
4343
* @public
4444
* <p>Removes the specified user from the specified group.</p>
45-
* <p>Calling this action requires developer credentials.</p>
45+
* <p>Calling this action requires developer credentials.</p>
4646
* @example
4747
* Use a bare-bones client and the command you need to make an API call.
4848
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminResetUserPasswordCommand.ts

+2-4
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,14 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
4747
* @public
4848
* <p>Resets the specified user's password in a user pool as an administrator. Works on any
4949
* user.</p>
50-
* <p>When a developer calls this API, the current password is invalidated, so it must be
50+
* <p>When a developer calls this API, the current password is invalidated, so it must be
5151
* changed. If a user tries to sign in after the API is called, the app will get a
5252
* PasswordResetRequiredException exception back and should direct the user down the flow
5353
* to reset the password, which is the same as the forgot password flow. In addition, if
5454
* the user pool has phone verification selected and a verified phone number exists for the
5555
* user, or if email verification is selected and a verified email exists for the user,
5656
* calling this API will also result in sending a message to the end user with the code to
5757
* change their password.</p>
58-
*
5958
* <note>
6059
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
6160
* require you to register an origination phone number before you can send SMS messages
@@ -73,8 +72,7 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
7372
* of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
7473
* Developer Guide</i>.</p>
7574
* </note>
76-
*
77-
* <p>Calling this action requires developer credentials.</p>
75+
* <p>Calling this action requires developer credentials.</p>
7876
* @example
7977
* Use a bare-bones client and the command you need to make an API call.
8078
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminRespondToAuthChallengeCommand.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ export interface AdminRespondToAuthChallengeCommandOutput
4949
/**
5050
* @public
5151
* <p>Responds to an authentication challenge, as an administrator.</p>
52-
*
5352
* <note>
5453
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
5554
* require you to register an origination phone number before you can send SMS messages
@@ -67,8 +66,7 @@ export interface AdminRespondToAuthChallengeCommandOutput
6766
* of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
6867
* Developer Guide</i>.</p>
6968
* </note>
70-
*
71-
* <p>Calling this action requires developer credentials.</p>
69+
* <p>Calling this action requires developer credentials.</p>
7270
* @example
7371
* Use a bare-bones client and the command you need to make an API call.
7472
* ```javascript

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminSetUserPasswordCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ export interface AdminSetUserPasswordCommandOutput extends AdminSetUserPasswordR
4747
* @public
4848
* <p>Sets the specified user's password in a user pool as an administrator. Works on any
4949
* user. </p>
50-
* <p>The password can be temporary or permanent. If it is temporary, the user status enters
50+
* <p>The password can be temporary or permanent. If it is temporary, the user status enters
5151
* the <code>FORCE_CHANGE_PASSWORD</code> state. When the user next tries to sign in, the
5252
* InitiateAuth/AdminInitiateAuth response will contain the
5353
* <code>NEW_PASSWORD_REQUIRED</code> challenge. If the user doesn't sign in before it
5454
* expires, the user won't be able to sign in, and an administrator must reset their
5555
* password. </p>
56-
* <p>Once the user has set a new password, or the password is permanent, the user status is
56+
* <p>Once the user has set a new password, or the password is permanent, the user status is
5757
* set to <code>Confirmed</code>.</p>
5858
* @example
5959
* Use a bare-bones client and the command you need to make an API call.

Diff for: ‎clients/client-cognito-identity-provider/src/commands/AdminUpdateDeviceStatusCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface AdminUpdateDeviceStatusCommandOutput extends AdminUpdateDeviceS
4646
/**
4747
* @public
4848
* <p>Updates the device status as an administrator.</p>
49-
* <p>Calling this action requires developer credentials.</p>
49+
* <p>Calling this action requires developer credentials.</p>
5050
* @example
5151
* Use a bare-bones client and the command you need to make an API call.
5252
* ```javascript

0 commit comments

Comments
 (0)