StartUserImportJob
Instructs your user pool to start importing users from a CSV file that contains their usernames and attributes. For more information about importing users from a CSV file, see Importing users from a CSV file.
To create a job that you can start with this request, see CreateUserImportJob. To generate a template for your import, see GetCSVHeader.
Request Syntax
{
"JobId": "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.
- JobId
-
The ID of a user import job that you previously created.
To get information about jobs that you can start, see ListUserImportJobs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
import-[0-9a-zA-Z-]+Required: Yes
- UserPoolId
-
The ID of the user pool that you want to start importing users into.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+Required: Yes
Response Syntax
{
"UserImportJob": {
"CloudWatchLogsRoleArn": "string",
"CompletionDate": number,
"CompletionMessage": "string",
"CreationDate": number,
"FailedUsers": number,
"ImportedUsers": number,
"JobId": "string",
"JobName": "string",
"PreSignedUrl": "string",
"SkippedUsers": number,
"StartDate": number,
"Status": "string",
"UserPoolId": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- UserImportJob
-
The details of the user import job. Includes logging destination, status, and the Amazon S3 pre-signed URL for CSV upload.
Type: UserImportJobType object
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
- PreconditionNotMetException
-
This exception is thrown when a precondition is not met.
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
Examples
Example
The following example request starts the requested import job.
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.StartUserImportJob
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
{
"JobId": "import-mAgUtd8PMm",
"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
{
"UserImportJob": {
"CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/example-cloudwatch-logs-role",
"CreationDate": 1736442975.904,
"FailedUsers": 0,
"ImportedUsers": 0,
"JobId": "import-mAgUtd8PMm",
"JobName": "Customer import",
"PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]",
"SkippedUsers": 0,
"StartDate": 1736443020.081,
"Status": "Pending",
"UserPoolId": "us-west-2_EXAMPLE"
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
