Amazon Cognito · JSON Structure

Cognito Idp Describe User Pool Request Structure

Represents the request to describe the user pool.

Type: object Properties: 1 Required: 1
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

DescribeUserPoolRequest is a JSON Structure definition published by Amazon Cognito, describing 1 property, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

UserPoolId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID for the user pool you want to describe."
        }
      ]
    }
  },
  "required": [
    "UserPoolId"
  ],
  "description": "Represents the request to describe the user pool.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-describe-user-pool-request-structure.json",
  "name": "DescribeUserPoolRequest"
}