Amazon Cognito Identity Provider
API Reference (API Version 2016-04-18)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Contains information about the schema attribute.



The attribute data type.

Type: String

Valid Values: String | Number | DateTime | Boolean

Required: No


Specifies whether the attribute type is developer only.

Type: Boolean

Required: No


Specifies whether the value of the attribute can be changed.

For any user pool attribute that's mapped to an identity provider attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.

Type: Boolean

Required: No


A schema attribute of the name type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Required: No


Specifies the constraints for an attribute of the number type.

Type: NumberAttributeConstraintsType object

Required: No


Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.

Type: Boolean

Required: No


Specifies the constraints for an attribute of the string type.

Type: StringAttributeConstraintsType object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: