@aws-sdk/client-cognito-identity-provider 3.709.0 → 3.712.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/README.md +5 -0
  2. package/dist-types/CognitoIdentityProvider.d.ts +5 -0
  3. package/dist-types/CognitoIdentityProviderClient.d.ts +5 -0
  4. package/dist-types/commands/AddCustomAttributesCommand.d.ts +6 -1
  5. package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +4 -2
  6. package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +3 -2
  7. package/dist-types/commands/AdminDeleteUserCommand.d.ts +1 -1
  8. package/dist-types/commands/AdminDisableUserCommand.d.ts +3 -3
  9. package/dist-types/commands/AdminEnableUserCommand.d.ts +2 -1
  10. package/dist-types/commands/AdminForgetDeviceCommand.d.ts +3 -1
  11. package/dist-types/commands/AdminGetDeviceCommand.d.ts +2 -1
  12. package/dist-types/commands/AdminGetUserCommand.d.ts +3 -3
  13. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +5 -1
  14. package/dist-types/commands/AdminListDevicesCommand.d.ts +4 -1
  15. package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +3 -1
  16. package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +2 -2
  17. package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +3 -1
  18. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +12 -10
  19. package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +3 -0
  20. package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +15 -10
  21. package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +5 -1
  22. package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +6 -1
  23. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +6 -5
  24. package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +5 -2
  25. package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +1 -0
  26. package/dist-types/commands/ConfirmDeviceCommand.d.ts +4 -2
  27. package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +2 -1
  28. package/dist-types/commands/ConfirmSignUpCommand.d.ts +2 -2
  29. package/dist-types/commands/CreateGroupCommand.d.ts +2 -1
  30. package/dist-types/commands/CreateIdentityProviderCommand.d.ts +2 -1
  31. package/dist-types/commands/CreateManagedLoginBrandingCommand.d.ts +6 -3
  32. package/dist-types/commands/CreateResourceServerCommand.d.ts +3 -1
  33. package/dist-types/commands/CreateUserImportJobCommand.d.ts +4 -1
  34. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +6 -3
  35. package/dist-types/commands/CreateUserPoolCommand.d.ts +4 -2
  36. package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +10 -2
  37. package/dist-types/commands/DeleteGroupCommand.d.ts +25 -2
  38. package/dist-types/commands/DeleteIdentityProviderCommand.d.ts +23 -1
  39. package/dist-types/commands/DeleteManagedLoginBrandingCommand.d.ts +3 -1
  40. package/dist-types/commands/DeleteResourceServerCommand.d.ts +24 -1
  41. package/dist-types/commands/DeleteUserAttributesCommand.d.ts +3 -1
  42. package/dist-types/commands/DeleteUserCommand.d.ts +2 -1
  43. package/dist-types/commands/DeleteUserPoolClientCommand.d.ts +2 -1
  44. package/dist-types/commands/DeleteUserPoolCommand.d.ts +3 -1
  45. package/dist-types/commands/DeleteUserPoolDomainCommand.d.ts +3 -1
  46. package/dist-types/commands/DeleteWebAuthnCredentialCommand.d.ts +7 -1
  47. package/dist-types/commands/DescribeIdentityProviderCommand.d.ts +2 -1
  48. package/dist-types/commands/DescribeManagedLoginBrandingByClientCommand.d.ts +2 -2
  49. package/dist-types/commands/DescribeManagedLoginBrandingCommand.d.ts +2 -2
  50. package/dist-types/commands/DescribeResourceServerCommand.d.ts +1 -1
  51. package/dist-types/commands/DescribeRiskConfigurationCommand.d.ts +4 -1
  52. package/dist-types/commands/DescribeUserImportJobCommand.d.ts +1 -1
  53. package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +3 -2
  54. package/dist-types/commands/DescribeUserPoolCommand.d.ts +3 -1
  55. package/dist-types/commands/DescribeUserPoolDomainCommand.d.ts +22 -1
  56. package/dist-types/commands/GlobalSignOutCommand.d.ts +4 -1
  57. package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +3 -0
  58. package/dist-types/commands/UpdateManagedLoginBrandingCommand.d.ts +4 -1
  59. package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +17 -19
  60. package/dist-types/index.d.ts +5 -0
  61. package/dist-types/models/models_0.d.ts +512 -360
  62. package/dist-types/models/models_1.d.ts +79 -67
  63. package/package.json +5 -5
@@ -27,8 +27,31 @@ declare const DeleteGroupCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a group.</p>
31
- * <p>Calling this action requires developer credentials.</p>
30
+ * <p>Deletes a group from the specified user pool. When you delete a group, that group no
31
+ * longer contributes to users' <code>cognito:preferred_group</code> or
32
+ * <code>cognito:groups</code> claims, and no longer influence access-control decision
33
+ * that are based on group membership. For more information about user pool groups, see
34
+ * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html">Adding groups to a user pool</a>.</p>
35
+ * <note>
36
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
37
+ * this operation, you must use IAM credentials to authorize requests, and you must
38
+ * grant yourself the corresponding IAM permission in a policy.</p>
39
+ * <p class="title">
40
+ * <b>Learn more</b>
41
+ * </p>
42
+ * <ul>
43
+ * <li>
44
+ * <p>
45
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
46
+ * </p>
47
+ * </li>
48
+ * <li>
49
+ * <p>
50
+ * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
51
+ * </p>
52
+ * </li>
53
+ * </ul>
54
+ * </note>
32
55
  * @example
33
56
  * Use a bare-bones client and the command you need to make an API call.
34
57
  * ```javascript
@@ -27,7 +27,29 @@ declare const DeleteIdentityProviderCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes an IdP for a user pool.</p>
30
+ * <p>Deletes a user pool identity provider (IdP). After you delete an IdP, users can no
31
+ * longer sign in to your user pool through that IdP. For more information about user pool
32
+ * IdPs, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html">Third-party IdP sign-in</a>.</p>
33
+ * <note>
34
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
35
+ * this operation, you must use IAM credentials to authorize requests, and you must
36
+ * grant yourself the corresponding IAM permission in a policy.</p>
37
+ * <p class="title">
38
+ * <b>Learn more</b>
39
+ * </p>
40
+ * <ul>
41
+ * <li>
42
+ * <p>
43
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
44
+ * </p>
45
+ * </li>
46
+ * <li>
47
+ * <p>
48
+ * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
49
+ * </p>
50
+ * </li>
51
+ * </ul>
52
+ * </note>
31
53
  * @example
32
54
  * Use a bare-bones client and the command you need to make an API call.
33
55
  * ```javascript
@@ -28,7 +28,9 @@ declare const DeleteManagedLoginBrandingCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Deletes a managed login branding style. When you delete a style, you delete the
31
- * branding association for an app client and restore it to default settings.</p>
31
+ * branding association for an app client. When an app client doesn't have a style
32
+ * assigned, your managed login pages for that app client are nonfunctional until you
33
+ * create a new style or switch the domain branding version.</p>
32
34
  * <note>
33
35
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
34
36
  * this operation, you must use IAM credentials to authorize requests, and you must
@@ -27,7 +27,30 @@ declare const DeleteResourceServerCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a resource server.</p>
30
+ * <p>Deletes a resource server. After you delete a resource server, users can no longer
31
+ * generate access tokens with scopes that are associate with that resource server.</p>
32
+ * <p>Resource servers are associated with custom scopes and machine-to-machine (M2M)
33
+ * authorization. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html">Access control with resource servers</a>.</p>
34
+ * <note>
35
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
36
+ * this operation, you must use IAM credentials to authorize requests, and you must
37
+ * grant yourself the corresponding IAM permission in a policy.</p>
38
+ * <p class="title">
39
+ * <b>Learn more</b>
40
+ * </p>
41
+ * <ul>
42
+ * <li>
43
+ * <p>
44
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
45
+ * </p>
46
+ * </li>
47
+ * <li>
48
+ * <p>
49
+ * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
50
+ * </p>
51
+ * </li>
52
+ * </ul>
53
+ * </note>
31
54
  * @example
32
55
  * Use a bare-bones client and the command you need to make an API call.
33
56
  * ```javascript
@@ -27,7 +27,9 @@ declare const DeleteUserAttributesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes the attributes for a user.</p>
30
+ * <p>Self-deletes attributes for a user. For example, your application can submit a request
31
+ * to this operation when a user wants to remove their <code>birthdate</code> attribute
32
+ * value.</p>
31
33
  * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
32
34
  * <note>
33
35
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
@@ -27,7 +27,8 @@ declare const DeleteUserCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Allows a user to delete their own user profile.</p>
30
+ * <p>Self-deletes a user profile. A deleted user profile can no longer be used to sign in
31
+ * and can't be restored.</p>
31
32
  * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
32
33
  * <note>
33
34
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
@@ -27,7 +27,8 @@ declare const DeleteUserPoolClientCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Allows the developer to delete the user pool client.</p>
30
+ * <p>Deletes a user pool app client. After you delete an app client, users can no longer
31
+ * sign in to the associated application.</p>
31
32
  * @example
32
33
  * Use a bare-bones client and the command you need to make an API call.
33
34
  * ```javascript
@@ -27,7 +27,9 @@ declare const DeleteUserPoolCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes the specified Amazon Cognito user pool.</p>
30
+ * <p>Deletes a user pool. After you delete a user pool, users can no longer sign in to any
31
+ * associated applications. </p>
32
+ * <p></p>
31
33
  * @example
32
34
  * Use a bare-bones client and the command you need to make an API call.
33
35
  * ```javascript
@@ -27,7 +27,9 @@ declare const DeleteUserPoolDomainCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a domain for a user pool.</p>
30
+ * <p>Given a user pool ID and domain identifier, deletes a user pool domain. After you
31
+ * delete a user pool domain, your managed login pages and authorization server are no
32
+ * longer available.</p>
31
33
  * @example
32
34
  * Use a bare-bones client and the command you need to make an API call.
33
35
  * ```javascript
@@ -27,9 +27,15 @@ declare const DeleteWebAuthnCredentialCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a registered passkey, or webauthN, device for the currently signed-in
30
+ * <p>Deletes a registered passkey, or webauthN, authenticator for the currently signed-in
31
31
  * user.</p>
32
32
  * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
33
+ * <note>
34
+ * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
35
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
36
+ * grant IAM permissions in policies. For more information about authorization models in
37
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
38
+ * </note>
33
39
  * @example
34
40
  * Use a bare-bones client and the command you need to make an API call.
35
41
  * ```javascript
@@ -27,7 +27,8 @@ declare const DescribeIdentityProviderCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets information about a specific IdP.</p>
30
+ * <p>Given a user pool ID and identity provider (IdP) name, returns details about the
31
+ * IdP.</p>
31
32
  * @example
32
33
  * Use a bare-bones client and the command you need to make an API call.
33
34
  * ```javascript
@@ -27,8 +27,8 @@ declare const DescribeManagedLoginBrandingByClientCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>When given the ID of a user pool app client, returns detailed information about the
31
- * style assigned to the app client.</p>
30
+ * <p>Given the ID of a user pool app client, returns detailed information about the style
31
+ * assigned to the app client.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -27,8 +27,8 @@ declare const DescribeManagedLoginBrandingCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>When given the ID of a managed login branding style, returns detailed information
31
- * about the style.</p>
30
+ * <p>Given the ID of a managed login branding style, returns detailed information about the
31
+ * style.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -27,7 +27,7 @@ declare const DescribeResourceServerCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Describes a resource server.</p>
30
+ * <p>Describes a resource server. For more information about resource servers, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html">Access control with resource servers</a>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,10 @@ declare const DescribeRiskConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Describes the risk configuration.</p>
30
+ * <p>Given an app client or user pool ID where threat protection is configured, describes
31
+ * the risk configuration. This operation returns details about adaptive authentication,
32
+ * compromised credentials, and IP-address allow- and denylists. For more information about
33
+ * threat protection, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html">Threat protection</a>.</p>
31
34
  * @example
32
35
  * Use a bare-bones client and the command you need to make an API call.
33
36
  * ```javascript
@@ -27,7 +27,7 @@ declare const DescribeUserImportJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Describes the user import job.</p>
30
+ * <p>Describes a user import job. For more information about user CSV import, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html">Importing users from a CSV file</a>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,8 +27,9 @@ declare const DescribeUserPoolClientCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Client method for returning the configuration information and metadata of the
31
- * specified user pool app client.</p>
30
+ * <p>Given an app client ID, returns configuration information. This operation is useful
31
+ * when you want to inspect an existing app client and programmatically replicate the
32
+ * configuration to another app client. For more information about app clients, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html">App clients</a>.</p>
32
33
  * <note>
33
34
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
34
35
  * this operation, you must use IAM credentials to authorize requests, and you must
@@ -27,7 +27,9 @@ declare const DescribeUserPoolCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns the configuration information and metadata of the specified user pool.</p>
30
+ * <p>Given a user pool ID, returns configuration information. This operation is useful when
31
+ * you want to inspect an existing user pool and programmatically replicate the
32
+ * configuration to another user pool.</p>
31
33
  * <note>
32
34
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
33
35
  * this operation, you must use IAM credentials to authorize requests, and you must
@@ -27,7 +27,28 @@ declare const DescribeUserPoolDomainCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets information about a domain.</p>
30
+ * <p>Given a user pool domain name, returns information about the domain
31
+ * configuration.</p>
32
+ * <note>
33
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
34
+ * this operation, you must use IAM credentials to authorize requests, and you must
35
+ * grant yourself the corresponding IAM permission in a policy.</p>
36
+ * <p class="title">
37
+ * <b>Learn more</b>
38
+ * </p>
39
+ * <ul>
40
+ * <li>
41
+ * <p>
42
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
43
+ * </p>
44
+ * </li>
45
+ * <li>
46
+ * <p>
47
+ * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
48
+ * </p>
49
+ * </li>
50
+ * </ul>
51
+ * </note>
31
52
  * @example
32
53
  * Use a bare-bones client and the command you need to make an API call.
33
54
  * ```javascript
@@ -50,7 +50,10 @@ declare const GlobalSignOutCommand_base: {
50
50
  * requests.</p>
51
51
  * </li>
52
52
  * </ul>
53
- * <p>Other requests might be valid until your user's token expires.</p>
53
+ * <p>Other requests might be valid until your user's token expires. This operation
54
+ * doesn't clear the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">managed login</a> session cookie. To clear the session for
55
+ * a user who signed in with managed login or the classic hosted UI, direct their browser
56
+ * session to the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html">logout endpoint</a>.</p>
54
57
  * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
55
58
  * <note>
56
59
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
@@ -36,6 +36,9 @@ declare const SetUserMFAPreferenceCommand_base: {
36
36
  * unless device tracking is turned on and the device has been trusted. If you want MFA to
37
37
  * be applied selectively based on the assessed risk level of sign-in attempts, deactivate
38
38
  * MFA for users and turn on Adaptive Authentication for the user pool.</p>
39
+ * <p>This operation doesn't reset an existing TOTP MFA for a user. To register a new
40
+ * TOTP factor for a user, make an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html">AssociateSoftwareToken</a> request. For more information,
41
+ * see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa-totp.html">TOTP software token MFA</a>.</p>
39
42
  * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
40
43
  * <note>
41
44
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
@@ -36,7 +36,10 @@ declare const UpdateManagedLoginBrandingCommand_base: {
36
36
  * doesn't require that you pass all parameters in one request and preserves existing
37
37
  * style settings that you don't specify. If your request is larger than 2MB, separate it
38
38
  * into multiple requests, each with a size smaller than the limit. </p>
39
- * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/managed-login-brandingdesigner.html#branding-designer-api">API and SDK operations for managed login branding</a>.</p>
39
+ * <p>As a best practice, modify the output of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBrandingByClient.html">DescribeManagedLoginBrandingByClient</a> into the request parameters for this
40
+ * operation. To get all settings, set <code>ReturnMergedResources</code> to
41
+ * <code>true</code>. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/managed-login-brandingdesigner.html#branding-designer-api">API and SDK operations for managed login branding</a>
42
+ * </p>
40
43
  * <note>
41
44
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
42
45
  * this operation, you must use IAM credentials to authorize requests, and you must
@@ -27,25 +27,23 @@ declare const UpdateUserPoolDomainCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user
31
- * pool.</p>
32
- * <p>You can use this operation to provide the Amazon Resource Name (ARN) of a new
33
- * certificate to Amazon Cognito. You can't use it to change the domain for a user pool.</p>
34
- * <p>A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and
35
- * sign-in pages for your application. When you set up a custom domain, you provide a
36
- * certificate that you manage with Certificate Manager (ACM). When necessary, you can use this
37
- * operation to change the certificate that you applied to your custom domain.</p>
38
- * <p>Usually, this is unnecessary following routine certificate renewal with ACM. When
39
- * you renew your existing certificate in ACM, the ARN for your certificate remains the
40
- * same, and your custom domain uses the new certificate automatically.</p>
41
- * <p>However, if you replace your existing certificate with a new one, ACM gives the new
42
- * certificate a new ARN. To apply the new certificate to your custom domain, you must
43
- * provide this ARN to Amazon Cognito.</p>
44
- * <p>When you add your new certificate in ACM, you must choose US East (N. Virginia) as
45
- * the Amazon Web Services Region.</p>
46
- * <p>After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new
47
- * certificate to your custom domain.</p>
48
- * <p>For more information about adding a custom domain to your user pool, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html">Using Your Own Domain for the Hosted UI</a>.</p>
30
+ * <p>A user pool domain hosts managed login, an authorization server and web server for
31
+ * authentication in your application. This operation updates the branding version for user
32
+ * pool domains between <code>1</code> for hosted UI (classic) and <code>2</code> for
33
+ * managed login. It also updates the SSL certificate for user pool custom domains.</p>
34
+ * <p>Changes to the domain branding version take up to one minute to take effect for a
35
+ * prefix domain and up to five minutes for a custom domain.</p>
36
+ * <p>This operation doesn't change the name of your user pool domain. To change your
37
+ * domain, delete it with <code>DeleteUserPoolDomain</code> and create a new domain with
38
+ * <code>CreateUserPoolDomain</code>.</p>
39
+ * <p>You can pass the ARN of a new Certificate Manager certificate in this request. Typically, ACM
40
+ * certificates automatically renew and you user pool can continue to use the same ARN. But
41
+ * if you generate a new certificate for your custom domain name, replace the original
42
+ * configuration with the new ARN in this request.</p>
43
+ * <p>ACM certificates for custom domains must be in the US East (N. Virginia)
44
+ * Amazon Web Services Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute
45
+ * your new certificate to your custom domain.</p>
46
+ * <p>For more information about adding a custom domain to your user pool, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html">Configuring a user pool domain</a>.</p>
49
47
  * <note>
50
48
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
51
49
  * this operation, you must use IAM credentials to authorize requests, and you must
@@ -79,6 +79,11 @@
79
79
  * for Ruby V3</a>
80
80
  * </p>
81
81
  * </li>
82
+ * <li>
83
+ * <p>
84
+ * <a href="https://sdk.amazonaws.com/kotlin/api/latest/cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider/-cognito-identity-provider-client/index.html">Amazon Web Services SDK for Kotlin</a>
85
+ * </p>
86
+ * </li>
82
87
  * </ul>
83
88
  * <p>To get started with an Amazon Web Services SDK, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>. For example actions and scenarios, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/service_code_examples_cognito-identity-provider.html">Code examples for Amazon Cognito Identity Provider using Amazon Web Services
84
89
  * SDKs</a>.</p>