AddCustomAttributes
Adds additional user attributes to the user pool schema.
Note
Amazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Request Syntax
{
"CustomAttributes": [
{
"AttributeDataType": "string
",
"DeveloperOnlyAttribute": boolean
,
"Mutable": boolean
,
"Name": "string
",
"NumberAttributeConstraints": {
"MaxValue": "string
",
"MinValue": "string
"
},
"Required": boolean
,
"StringAttributeConstraints": {
"MaxLength": "string
",
"MinLength": "string
"
}
}
],
"UserPoolId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- CustomAttributes
-
An array of custom attributes, such as Mutable and Name.
Type: Array of SchemaAttributeType objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Required: Yes
- UserPoolId
-
The user pool ID for the user pool where you want to add custom attributes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user isn't authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service can't find the requested resource.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
- UserImportInProgressException
-
This exception is thrown when you're trying to modify a user pool while a user import job is in progress for that pool.
HTTP Status Code: 400
Examples
Example
This example request adds the mutable custom attribute
custom:deliverables
, a string with a maximum length of 255
characters, to the user pool schema.
Sample Request
POST HTTP/1.1
Host: cognito-idp.us-west-2.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: gzip, deflate, br
X-Amz-Target: AWSCognitoIdentityProviderService.AddCustomAttributes
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
{
"CustomAttributes": [
{
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Name": "deliverables",
"Required": false,
"StringAttributeConstraints": {
"MaxLength": "255",
"MinLength": "1"
}
}
],
"UserPoolId": "us-west-2_EXAMPLE"
}
Sample Response
HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive
{}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: