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.CreateUserPool API

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

Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.CreateUserPool 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 74 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 74 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.CreateUserPool 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.CreateUserPool 1
POST
/#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserPool
Amazon Cognito Create User Pool
CreateUserPool 8 params body → 200480481482483484485486

Schemas 74

The contract defines 74 schemas that model the data the API accepts and returns. The most detailed are UserPoolType (33 properties), CreateUserPoolRequest (23 properties), LambdaConfigType (13 properties), SchemaAttributeType (7 properties). Each schema is shown below with its type and property counts.

UserPoolMfaType
string
UserPoolPolicyType
object
The policy associated with a user pool.
1 property
RegionCodeType
string
IntegerType
integer
RecoveryOptionNameType
string
UserPoolIdType
string
AttributeDataType
string
EmailVerificationSubjectType
string
AdminCreateUserConfigType
object
The configuration for creating a new user profile.
3 properties
MessageTemplateType
object
The message template structure.
3 properties
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
CustomSMSLambdaVersionConfigType
object
A custom SMS sender Lambda configuration type.
2 properties 2 required
LambdaConfigType
object
Specifies the configuration for Lambda triggers.
13 properties
PriorityType
integer
UsernameConfigurationType
object
The username configuration type.
1 property 1 required
InvalidEmailRoleAccessPolicyException
AccountRecoverySettingType
object
The data type for AccountRecoverySetting .
1 property
StringAttributeConstraintsType
object
The constraints associated with a string attribute.
2 properties
InternalErrorException
CustomEmailLambdaVersionConfigType
object
A custom email sender Lambda configuration type.
2 properties 2 required
CreateUserPoolResponse
object
Represents the response from the server for the request to create a user pool.
1 property
TagValueType
string
PasswordPolicyMinLengthType
integer
NumberAttributeConstraintsType
object
The minimum and maximum values of an attribute that is of the number data type.
2 properties
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
NotAuthorizedException
DeletionProtectionType
string
EmailVerificationSubjectByLinkType
string
AdminCreateUserUnusedAccountValidityDaysType
integer
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
DateType
string
TooManyRequestsException
StringType
string
EmailVerificationMessageByLinkType
string
CustomAttributeNameType
string
UserPoolType
object
A container for information about the user pool.
33 properties
EmailAddressType
string
BooleanType
boolean
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
LimitExceededException
SchemaAttributesListType
array
DomainType
string
CustomEmailSenderLambdaVersionType
string
ArnType
string
VerifiedAttributesListType
array
UsernameAttributeType
string
UserPoolTagsType
object
UserPoolNameType
string
TemporaryPasswordValidityDaysType
integer
AttributesRequireVerificationBeforeUpdateType
array
AliasAttributesListType
array
EmailVerificationMessageType
string
RecoveryMechanismsType
array
InvalidSmsRoleTrustRelationshipException
UsernameAttributesListType
array
PasswordPolicyType
object
The password policy type.
6 properties
StatusType
string
SESConfigurationSet
string
UserPoolTaggingException
DefaultEmailOptionType
string
AdvancedSecurityModeType
string
CreateUserPoolRequest
object
Represents the request to create a user pool.
23 properties 1 required
CustomSMSSenderLambdaVersionType
string
AliasAttributeType
string
SmsVerificationMessageType
string
SchemaAttributeType
object
A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefi…
7 properties
RecoveryOptionType
object
A map containing a priority as a key, and recovery method name as a value.
2 properties 2 required
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
WrappedBooleanType
boolean

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-cognito-x-amz-target-awscognitoidentityproviderservice-createuserpool-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.CreateUserPool 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.