openapi: 3.0.0
info:
version: 2014-06-30
x-release: v4
title: 'Amazon Cognito Identity #X Amz Target=AWSCognitoIdentityProviderService.AddCustomAttributes #X Amz Target=AWSCognitoIdentityProviderService.AddCustomAttributes #X Amz Target=AWSCognitoIdentityProviderService.UpdateUserPool API'
description: <fullname>Amazon Cognito Federated Identities</fullname> <p>Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. It uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.</p> <p>Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.</p> <p>For a description of the authentication flow from the Amazon Cognito Developer Guide see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication Flow</a>.</p> <p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated Identities</a>.</p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: cognito-identity
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cognito-identity-2014-06-30.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://cognito-identity.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Cognito Identity multi-region endpoint
- url: https://cognito-identity.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Cognito Identity multi-region endpoint
- url: http://cognito-identity.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia)
- url: https://cognito-identity.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSCognitoIdentityProviderService.UpdateUserPool'
paths:
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateUserPool:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateUserPool
description: <p>Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>. If you don't provide a value for an attribute, it will be set to the default value. </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 to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out 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>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserPoolResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
UpdateUserPool480Example:
summary: Default UpdateUserPool 480 response
x-microcks-default: true
value: example
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
examples:
UpdateUserPool481Example:
summary: Default UpdateUserPool 481 response
x-microcks-default: true
value: example
'482':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
UpdateUserPool482Example:
summary: Default UpdateUserPool 482 response
x-microcks-default: true
value: example
'483':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
UpdateUserPool483Example:
summary: Default UpdateUserPool 483 response
x-microcks-default: true
value: example
'484':
description: NotAuthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/NotAuthorizedException'
examples:
UpdateUserPool484Example:
summary: Default UpdateUserPool 484 response
x-microcks-default: true
value: example
'485':
description: UserImportInProgressException
content:
application/json:
schema:
$ref: '#/components/schemas/UserImportInProgressException'
examples:
UpdateUserPool485Example:
summary: Default UpdateUserPool 485 response
x-microcks-default: true
value: example
'486':
description: InternalErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalErrorException'
examples:
UpdateUserPool486Example:
summary: Default UpdateUserPool 486 response
x-microcks-default: true
value: example
'487':
description: InvalidSmsRoleAccessPolicyException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidSmsRoleAccessPolicyException'
examples:
UpdateUserPool487Example:
summary: Default UpdateUserPool 487 response
x-microcks-default: true
value: example
'488':
description: InvalidSmsRoleTrustRelationshipException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidSmsRoleTrustRelationshipException'
examples:
UpdateUserPool488Example:
summary: Default UpdateUserPool 488 response
x-microcks-default: true
value: example
'489':
description: UserPoolTaggingException
content:
application/json:
schema:
$ref: '#/components/schemas/UserPoolTaggingException'
examples:
UpdateUserPool489Example:
summary: Default UpdateUserPool 489 response
x-microcks-default: true
value: example
'490':
description: InvalidEmailRoleAccessPolicyException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidEmailRoleAccessPolicyException'
examples:
UpdateUserPool490Example:
summary: Default UpdateUserPool 490 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserPoolRequest'
examples:
UpdateUserPoolRequestExample:
summary: Default UpdateUserPool request
x-microcks-default: true
value:
UserPoolId: us-east-1_AbCdEfGhI
Policies: example-value
DeletionProtection: example-value
LambdaConfig: example-value
AutoVerifiedAttributes: example-value
SmsVerificationMessage: example-value
EmailVerificationMessage: user@example.com
EmailVerificationSubject: user@example.com
VerificationMessageTemplate: example-value
SmsAuthenticationMessage: example-value
UserAttributeUpdateSettings: example-value
MfaConfiguration: example-value
DeviceConfiguration: example-value
EmailConfiguration: user@example.com
SmsConfiguration: example-value
UserPoolTags: example-value
AdminCreateUserConfig: example-value
UserPoolAddOns: example-value
AccountRecoverySetting: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSCognitoIdentityProviderService.UpdateUserPool
summary: Amazon Cognito Update User Pool
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=AWSCognitoIdentityProviderService.UpdateUserPool'
components:
schemas:
ResourceNotFoundException: {}
UserPoolMfaType:
type: string
enum:
- false
- true
- OPTIONAL
UserPoolAddOnsType:
type: object
required:
- AdvancedSecurityMode
properties:
AdvancedSecurityMode:
allOf:
- $ref: '#/components/schemas/AdvancedSecurityModeType'
- description: The advanced security mode.
description: The user pool add-ons type.
InvalidSmsRoleAccessPolicyException: {}
SmsConfigurationType:
type: object
required:
- SnsCallerArn
properties:
SnsCallerArn:
allOf:
- $ref: '#/components/schemas/ArnType'
- description: 'The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html">spending limit</a>. '
ExternalId:
allOf:
- $ref: '#/components/schemas/StringType'
- description: <p>The external ID provides additional security for your IAM role. You can use an <code>ExternalId</code> with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an <code>ExternalId</code>, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the <code>ExternalID</code>. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the <code>ExternalId</code>.</p> <p>For more information about the <code>ExternalId</code> of a role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html">How to use an external ID when granting access to your Amazon Web Services resources to a third party</a> </p>
SnsRegion:
allOf:
- $ref: '#/components/schemas/RegionCodeType'
- description: <p>The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported <b>Legacy Amazon SNS alternate Region</b>. </p> <p> Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html">SMS message settings for Amazon Cognito user pools</a>.</p>
description: The SMS configuration type is the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
InvalidSmsRoleTrustRelationshipException: {}
VerifiedAttributesListType:
type: array
items:
$ref: '#/components/schemas/VerifiedAttributeType'
AdminCreateUserUnusedAccountValidityDaysType:
type: integer
minimum: 0
maximum: 365
RecoveryMechanismsType:
type: array
items:
$ref: '#/components/schemas/RecoveryOptionType'
minItems: 1
maxItems: 2
SmsVerificationMessageType:
type: string
pattern: .*\{####\}.*
minLength: 6
maxLength: 140
UserAttributeUpdateSettingsType:
type: object
properties:
AttributesRequireVerificationBeforeUpdate:
allOf:
- $ref: '#/components/schemas/AttributesRequireVerificationBeforeUpdateType'
- description: <p>Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.</p> <p>You can verify an updated email address or phone number with a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifyUserAttribute.html">VerifyUserAttribute</a> API request. You can also call the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html">UpdateUserAttributes</a> or <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html">AdminUpdateUserAttributes</a> API and set <code>email_verified</code> or <code>phone_number_verified</code> to true.</p> <p>When <code>AttributesRequireVerificationBeforeUpdate</code> is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where <code>AttributesRequireVerificationBeforeUpdate</code> is false, API operations that change attribute values can immediately update a user’s <code>email</code> or <code>phone_number</code> attribute.</p>
description: The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates"> Verifying updates to email addresses and phone numbers</a>.
InvalidParameterException: {}
RegionCodeType:
type: string
minLength: 5
maxLength: 32
EmailVerificationSubjectByLinkType:
type: string
pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}\s]+'
minLength: 1
maxLength: 140
AccountRecoverySettingType:
type: object
properties:
RecoveryMechanisms:
allOf:
- $ref: '#/components/schemas/RecoveryMechanismsType'
- description: The list of <code>RecoveryOptionTypes</code>.
description: The data type for <code>AccountRecoverySetting</code>.
EmailAddressType:
type: string
pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}]+@[\p{L}\p{M}\p{S}\p{N}\p{P}]+'
DefaultEmailOptionType:
type: string
enum:
- CONFIRM_WITH_LINK
- CONFIRM_WITH_CODE
InternalErrorException: {}
DeviceConfigurationType:
type: object
properties:
ChallengeRequiredOnNewDevice:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: <p>When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).</p> <note> <p>Whether or not <code>ChallengeRequiredOnNewDevice</code> is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.</p> </note>
DeviceOnlyRememberedOnUserPrompt:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: <p>When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html"> ConfirmDevice</a> API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html"> UpdateDeviceStatus</a> API request.</p> <p>When <code>DeviceOnlyRememberedOnUserPrompt</code> is <code>false</code>, Amazon Cognito immediately remembers devices that you register in a <code>ConfirmDevice</code> API request.</p>
description: <p>The device-remembering configuration for a user pool. A <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html"> DescribeUserPool</a> request returns a null value for this object when the user pool isn't configured to remember devices. When device remembering is active, you can remember a user's device with a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html">ConfirmDevice</a> API request. Additionally. when the property <code>DeviceOnlyRememberedOnUserPrompt</code> is <code>true</code>, you must follow <code>ConfirmDevice</code> with an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html">UpdateDeviceStatus</a> API request that sets the user's device to <code>remembered</code> or <code>not_remembered</code>.</p> <p>To sign in with a remembered device, include <code>DEVICE_KEY</code> in the authentication parameters in your user's <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html"> InitiateAuth</a> request. If your app doesn't include a <code>DEVICE_KEY</code> parameter, the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html#API_InitiateAuth_ResponseSyntax">response</a> from Amazon Cognito includes newly-generated <code>DEVICE_KEY</code> and <code>DEVICE_GROUP_KEY</code> values under <code>NewDeviceMetadata</code>. Store these values to use in future device-authentication requests.</p> <note> <p>When you provide a value for any property of <code>DeviceConfiguration</code>, you activate the device remembering for the user pool.</p> </note>
AttributesRequireVerificationBeforeUpdateType:
type: array
items:
$ref: '#/components/schemas/VerifiedAttributeType'
TagValueType:
type: string
minLength: 0
maxLength: 256
StringType:
type: string
TooManyRequestsException: {}
SESConfigurationSet:
type: string
pattern: ^[a-zA-Z0-9_-]+$
minLength: 1
maxLength: 64
CustomSMSSenderLambdaVersionType:
type: string
enum:
- V1_0
RecoveryOptionNameType:
type: string
enum:
- verified_email
- verified_phone_number
- admin_only
NotAuthorizedException: {}
UpdateUserPoolRequest:
type: object
required:
- UserPoolId
title: UpdateUserPoolRequest
properties:
UserPoolId:
allOf:
- $ref: '#/components/schemas/UserPoolIdType'
- description: The user pool ID for the user pool you want to update.
Policies:
allOf:
- $ref: '#/components/schemas/UserPoolPolicyType'
- description: A container with the policies you want to update in a user pool.
DeletionProtection:
allOf:
- $ref: '#/components/schemas/DeletionProtectionType'
- description: <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.</p> <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request, Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool, send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an <code>UpdateUserPool</code> API request.</p>
LambdaConfig:
allOf:
- $ref: '#/components/schemas/LambdaConfigType'
- description: The Lambda configuration information from the request to update the user pool.
AutoVerifiedAttributes:
allOf:
- $ref: '#/components/schemas/VerifiedAttributesListType'
- description: The attributes that are automatically verified when Amazon Cognito requests to update user pools.
SmsVerificationMessage:
allOf:
- $ref: '#/components/schemas/SmsVerificationMessageType'
- description: This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.
EmailVerificationMessage:
allOf:
- $ref: '#/components/schemas/EmailVerificationMessageType'
- description: This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.
EmailVerificationSubject:
allOf:
- $ref: '#/components/schemas/EmailVerificationSubjectType'
- description: This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.
VerificationMessageTemplate:
allOf:
- $ref: '#/components/schemas/VerificationMessageTemplateType'
- description: The template for verification messages.
SmsAuthenticationMessage:
allOf:
- $ref: '#/components/schemas/SmsVerificationMessageType'
- description: The contents of the SMS authentication message.
UserAttributeUpdateSettings:
allOf:
- $ref: '#/components/schemas/UserAttributeUpdateSettingsType'
- description: The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates"> Verifying updates to email addresses and phone numbers</a>.
MfaConfiguration:
allOf:
- $ref: '#/components/schemas/UserPoolMfaType'
- description: <p>Possible values include:</p> <ul> <li> <p> <code>OFF</code> - MFA tokens aren't required and can't be specified during user registration.</p> </li> <li> <p> <code>ON</code> - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> API operation to turn MFA "ON" for existing user pools. </p> </li> <li> <p> <code>OPTIONAL</code> - Users have the option when registering to create an MFA token.</p> </li> </ul>
DeviceConfiguration:
allOf:
- $ref: '#/components/schemas/DeviceConfigurationType'
- description: <p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p> <note> <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p> </note>
EmailConfiguration:
allOf:
- $ref: '#/components/schemas/EmailConfigurationType'
- description: The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
SmsConfiguration:
allOf:
- $ref: '#/components/schemas/SmsConfigurationType'
- description: The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
UserPoolTags:
allOf:
- $ref: '#/components/schemas/UserPoolTagsType'
- description: The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
AdminCreateUserConfig:
allOf:
- $ref: '#/components/schemas/AdminCreateUserConfigType'
- description: The configuration for <code>AdminCreateUser</code> requests.
UserPoolAddOns:
allOf:
- $ref: '#/components/schemas/UserPoolAddOnsType'
- description: Enables advanced security risk detection. Set the key <code>AdvancedSecurityMode</code> to the value "AUDIT".
AccountRecoverySetting:
allOf:
- $ref: '#/components/schemas/AccountRecoverySettingType'
- description: The available verified method a user can use to recover their password when they call <code>ForgotPassword</code>. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
description: Represents the request to update the user pool.
EmailVerificationMessageType:
type: string
pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*'
minLength: 6
maxLength: 20000
VerifiedAttributeType:
type: string
enum:
- phone_number
- email
TemporaryPasswordValidityDaysType:
type: integer
minimum: 0
maximum: 365
RecoveryOptionType:
type: object
required:
- Priority
- Name
properties:
Priority:
allOf:
- $ref: '#/components/schemas/PriorityType'
- description: A positive integer specifying priority of a method with 1 being the highest priority.
Name:
allOf:
- $ref: '#/components/schemas/RecoveryOptionNameType'
- description: The recovery method for a user.
description: A map containing a priority as a key, and recovery method name as a value.
AdminCreateUserConfigType:
type: object
properties:
AllowAdminCreateUserOnly:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: Set to <code>True</code> if only the administrator is allowed to create user profiles. Set to <code>False</code> if users can sign themselves up via an app.
UnusedAccountValidityDays:
allOf:
- $ref: '#/components/schemas/AdminCreateUserUnusedAccountValidityDaysType'
- description: <p>The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usab
# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/openapi/aws-cognito-x-amz-target-awscognitoidentityproviderservice-updateuserpool-api-openapi.yml