How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.UpdateUserPool API

The #X Amz Target=AWSCognitoIdentityProviderService.UpdateUserPool API from Amazon Cognito — 1 operation(s) for #x amz target=awscognitoidentityproviderservice.updateuserpool.

Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.UpdateUserPool API is one of 126 APIs that Amazon Cognito publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a JSON-LD context, a getting-started guide, and 4 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 58 schemas. It is described by OpenAPI 3.2.0, at version 2016-04-18.

Requests are made against 4 base URLs: http://cognito-idp.{region}.amazonaws.com, https://cognito-idp.{region}.amazonaws.com, http://cognito-idp.{region}.amazonaws.com.cn, https://cognito-idp.{region}.amazonaws.com.cn.

1 operations 1 paths 58 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2016-04-18
Base URL
https://cognito-idp.us-east-1.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.UpdateUserPool API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

#X Amz Target=AWSCognitoIdentityProviderService.UpdateUserPool 1
POST
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateUserPool
Amazon Cognito Update User Pool
UpdateUserPool 8 params body → 200480481482483484485486

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are UpdateUserPoolRequest (19 properties), LambdaConfigType (13 properties), VerificationMessageTemplateType (6 properties), PasswordPolicyType (6 properties). Each schema is shown below with its type and property counts.

CustomEmailLambdaVersionConfigType
object
A custom email sender Lambda configuration type.
2 properties 2 required
UserPoolMfaType
string
ResourceNotFoundException
EmailAddressType
string
UserPoolPolicyType
object
The policy associated with a user pool.
1 property
ConcurrentModificationException
RegionCodeType
string
RecoveryMechanismsType
array
PasswordPolicyMinLengthType
integer
TagValueType
string
UserPoolIdType
string
RecoveryOptionNameType
string
InvalidSmsRoleTrustRelationshipException
BooleanType
boolean
EmailVerificationSubjectType
string
AdminCreateUserConfigType
object
The configuration for creating a new user profile.
3 properties
MessageTemplateType
object
The message template structure.
3 properties
PasswordPolicyType
object
The password policy type.
6 properties
UpdateUserPoolResponse
object
Represents the response from the server when you make a request to update the user pool.
InvalidSmsRoleAccessPolicyException
VerifiedAttributeType
string
EmailSendingAccountType
string
EmailConfigurationType
object
The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages…
5 properties
SmsConfigurationType
object
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 Ama…
3 properties 1 required
NotAuthorizedException
SESConfigurationSet
string
DefaultEmailOptionType
string
UserPoolTaggingException
AdvancedSecurityModeType
string
DeletionProtectionType
string
EmailVerificationSubjectByLinkType
string
VerificationMessageTemplateType
object
The template for verification messages.
6 properties
UserPoolAddOnsType
object
User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT . To confi…
1 property 1 required
AdminCreateUserUnusedAccountValidityDaysType
integer
CustomSMSLambdaVersionConfigType
object
A custom SMS sender Lambda configuration type.
2 properties 2 required
CustomSMSSenderLambdaVersionType
string
UpdateUserPoolRequest
object
Represents the request to update the user pool.
19 properties 1 required
DeviceConfigurationType
object
The device-remembering configuration for a user pool. A DescribeUserPool request returns a null value for this object when the user pool isn't configured to re…
2 properties
LambdaConfigType
object
Specifies the configuration for Lambda triggers.
13 properties
UserImportInProgressException
CustomEmailSenderLambdaVersionType
string
ArnType
string
PriorityType
integer
SmsVerificationMessageType
string
VerifiedAttributesListType
array
InvalidEmailRoleAccessPolicyException
RecoveryOptionType
object
A map containing a priority as a key, and recovery method name as a value.
2 properties 2 required
UserPoolTagsType
object
TooManyRequestsException
StringType
string
AccountRecoverySettingType
object
The data type for AccountRecoverySetting .
1 property
TemporaryPasswordValidityDaysType
integer
InvalidParameterException
UserAttributeUpdateSettingsType
object
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate , a user-pool setting that tells Ama…
1 property
AttributesRequireVerificationBeforeUpdateType
array
EmailVerificationMessageByLinkType
string
InternalErrorException
EmailVerificationMessageType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-cognito-x-amz-target-awscognitoidentityproviderservice-updateuserpool-api-openapi.yml Raw ↑

Other APIs Amazon Cognito publishes across the network.

Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AddCustomAttributes API
Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AdminAddUserToGroup API
Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AdminConfirmSignUp API
Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AdminCreateUser API
Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AdminDeleteUser API
Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AdminDeleteUserAttributes API
Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AdminDisableProviderForUser API
Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AdminDisableUser API
Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AdminEnableUser API
Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AdminForgetDevice API
Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AdminGetDevice API
Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AdminGetUser API
Where this information came from

This is an independent, third-party profile of Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.UpdateUserPool API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.