Skip to content

Commit

Permalink
feat(client-cognito-identity-provider): API model updated in Amazon C…
Browse files Browse the repository at this point in the history
…ognito
  • Loading branch information
awstools committed Jul 11, 2023
1 parent e0751b4 commit c654928
Show file tree
Hide file tree
Showing 57 changed files with 1,835 additions and 1,978 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2123,8 +2123,8 @@ export interface CognitoIdentityProvider {
* <p>Using the Amazon Cognito user pools API, you can create a user pool to manage directories and
* users. You can authenticate a user to obtain tokens related to user identity and access
* policies.</p>
* <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
* <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
* <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
* <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
* Documentation</a>.</p>
*/
export class CognitoIdentityProvider extends CognitoIdentityProviderClient implements CognitoIdentityProvider {}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -702,8 +702,8 @@ export interface CognitoIdentityProviderClientResolvedConfig extends CognitoIden
* <p>Using the Amazon Cognito user pools API, you can create a user pool to manage directories and
* users. You can authenticate a user to obtain tokens related to user identity and access
* policies.</p>
* <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
* <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
* <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
* <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
* Documentation</a>.</p>
*/
export class CognitoIdentityProviderClient extends __Client<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface AdminAddUserToGroupCommandOutput extends __MetadataBearer {}
/**
* @public
* <p>Adds the specified user to the specified group.</p>
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface AdminConfirmSignUpCommandOutput extends AdminConfirmSignUpRespo
* @public
* <p>Confirms user registration as an admin without using a confirmation code. Works on any
* user.</p>
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,8 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
/**
* @public
* <p>Creates a new user in the specified user pool.</p>
* <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via
* <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via
* email or phone (SMS).</p>
*
* <note>
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
* require you to register an origination phone number before you can send SMS messages
Expand All @@ -67,15 +66,14 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
* 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
* Developer Guide</i>.</p>
* </note>
*
* <p>This message is based on a template that you configured in your call to create or
* <p>This message is based on a template that you configured in your call to create or
* update a user pool. This template includes your custom sign-up instructions and
* placeholders for user name and temporary password.</p>
* <p>Alternatively, you can call <code>AdminCreateUser</code> with <code>SUPPRESS</code>
* <p>Alternatively, you can call <code>AdminCreateUser</code> with <code>SUPPRESS</code>
* for the <code>MessageAction</code> parameter, and Amazon Cognito won't send any email. </p>
* <p>In either case, the user will be in the <code>FORCE_CHANGE_PASSWORD</code> state until
* <p>In either case, the user will be in the <code>FORCE_CHANGE_PASSWORD</code> state until
* they sign in and change their password.</p>
* <p>
* <p>
* <code>AdminCreateUser</code> requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface AdminDeleteUserAttributesCommandOutput extends AdminDeleteUserA
* @public
* <p>Deletes the user attributes in a user pool as an administrator. Works on any
* user.</p>
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface AdminDeleteUserCommandOutput extends __MetadataBearer {}
/**
* @public
* <p>Deletes a user as an administrator. Works on any user.</p>
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,18 @@ export interface AdminDisableProviderForUserCommandOutput
* user is removed. When the external user signs in again, and the user is no longer
* attached to the previously linked <code>DestinationUser</code>, the user must create a
* new user account. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a>.</p>
* <p>This action is enabled only for admin access and requires developer
* <p>This action is enabled only for admin access and requires developer
* credentials.</p>
* <p>The <code>ProviderName</code> must match the value specified when creating an IdP for
* <p>The <code>ProviderName</code> must match the value specified when creating an IdP for
* the pool. </p>
* <p>To deactivate a native username + password user, the <code>ProviderName</code> value
* <p>To deactivate a native username + password user, the <code>ProviderName</code> value
* must be <code>Cognito</code> and the <code>ProviderAttributeName</code> must be
* <code>Cognito_Subject</code>. The <code>ProviderAttributeValue</code> must be the
* name that is used in the user pool for the user.</p>
* <p>The <code>ProviderAttributeName</code> must always be <code>Cognito_Subject</code> for
* <p>The <code>ProviderAttributeName</code> must always be <code>Cognito_Subject</code> for
* social IdPs. The <code>ProviderAttributeValue</code> must always be the exact subject
* that was used when the user was originally linked as a source user.</p>
* <p>For de-linking a SAML identity, there are two scenarios. If the linked identity has
* <p>For de-linking a SAML identity, there are two scenarios. If the linked identity has
* not yet been used to sign in, the <code>ProviderAttributeName</code> and
* <code>ProviderAttributeValue</code> must be the same values that were used for the
* <code>SourceUser</code> when the identities were originally linked using <code>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface AdminDisableUserCommandOutput extends AdminDisableUserResponse,
* @public
* <p>Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in,
* but still appears in the responses to <code>GetUser</code> and <code>ListUsers</code> API requests.</p>
* <p>You must make this API request with Amazon Web Services credentials that have <code>cognito-idp:AdminDisableUser</code> permissions.</p>
* <p>You must make this API request with Amazon Web Services credentials that have <code>cognito-idp:AdminDisableUser</code> permissions.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export interface AdminEnableUserCommandOutput extends AdminEnableUserResponse, _
/**
* @public
* <p>Enables the specified user as an administrator. Works on any user.</p>
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface AdminForgetDeviceCommandOutput extends __MetadataBearer {}
/**
* @public
* <p>Forgets the device, as an administrator.</p>
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface AdminGetDeviceCommandOutput extends AdminGetDeviceResponse, __M
/**
* @public
* <p>Gets the device, as an administrator.</p>
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export interface AdminGetUserCommandOutput extends AdminGetUserResponse, __Metad
* @public
* <p>Gets the specified user by user name in a user pool as an administrator. Works on any
* user.</p>
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
/**
* @public
* <p>Initiates the authentication flow, as an administrator.</p>
*
* <note>
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
* require you to register an origination phone number before you can send SMS messages
Expand All @@ -65,8 +64,7 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
* 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
* Developer Guide</i>.</p>
* </note>
*
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,18 @@ export interface AdminLinkProviderForUserCommandOutput extends AdminLinkProvider
* user account to an external federated user identity that has not yet been used to sign
* in. You can then use the federated user identity to sign in as the existing user
* account. </p>
* <p> For example, if there is an existing user with a username and password, this API
* <p> For example, if there is an existing user with a username and password, this API
* links that user to a federated user identity. When the user signs in with a federated
* user identity, they sign in as the existing user account.</p>
* <note>
* <note>
* <p>The maximum number of federated identities linked to a user is five.</p>
* </note>
* <important>
* </note>
* <important>
* <p>Because this API allows a user with an external federated identity to sign in as
* an existing user in the user pool, it is critical that it only be used with external
* IdPs and provider attributes that have been trusted by the application owner.</p>
* </important>
*
* <p>This action is administrative and requires developer credentials.</p>
* </important>
* <p>This action is administrative and requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface AdminListDevicesCommandOutput extends AdminListDevicesResponse,
/**
* @public
* <p>Lists devices, as an administrator.</p>
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export interface AdminListGroupsForUserCommandOutput extends AdminListGroupsForU
/**
* @public
* <p>Lists the groups that the user belongs to.</p>
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface AdminRemoveUserFromGroupCommandOutput extends __MetadataBearer
/**
* @public
* <p>Removes the specified user from the specified group.</p>
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,14 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
* @public
* <p>Resets the specified user's password in a user pool as an administrator. Works on any
* user.</p>
* <p>When a developer calls this API, the current password is invalidated, so it must be
* <p>When a developer calls this API, the current password is invalidated, so it must be
* changed. If a user tries to sign in after the API is called, the app will get a
* PasswordResetRequiredException exception back and should direct the user down the flow
* to reset the password, which is the same as the forgot password flow. In addition, if
* the user pool has phone verification selected and a verified phone number exists for the
* user, or if email verification is selected and a verified email exists for the user,
* calling this API will also result in sending a message to the end user with the code to
* change their password.</p>
*
* <note>
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
* require you to register an origination phone number before you can send SMS messages
Expand All @@ -73,8 +72,7 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
* 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
* Developer Guide</i>.</p>
* </note>
*
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ export interface AdminRespondToAuthChallengeCommandOutput
/**
* @public
* <p>Responds to an authentication challenge, as an administrator.</p>
*
* <note>
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
* require you to register an origination phone number before you can send SMS messages
Expand All @@ -67,8 +66,7 @@ export interface AdminRespondToAuthChallengeCommandOutput
* 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
* Developer Guide</i>.</p>
* </note>
*
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ export interface AdminSetUserPasswordCommandOutput extends AdminSetUserPasswordR
* @public
* <p>Sets the specified user's password in a user pool as an administrator. Works on any
* user. </p>
* <p>The password can be temporary or permanent. If it is temporary, the user status enters
* <p>The password can be temporary or permanent. If it is temporary, the user status enters
* the <code>FORCE_CHANGE_PASSWORD</code> state. When the user next tries to sign in, the
* InitiateAuth/AdminInitiateAuth response will contain the
* <code>NEW_PASSWORD_REQUIRED</code> challenge. If the user doesn't sign in before it
* expires, the user won't be able to sign in, and an administrator must reset their
* password. </p>
* <p>Once the user has set a new password, or the password is permanent, the user status is
* <p>Once the user has set a new password, or the password is permanent, the user status is
* set to <code>Confirmed</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export interface AdminUpdateDeviceStatusCommandOutput extends AdminUpdateDeviceS
/**
* @public
* <p>Updates the device status as an administrator.</p>
* <p>Calling this action requires developer credentials.</p>
* <p>Calling this action requires developer credentials.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Loading

0 comments on commit c654928

Please sign in to comment.