Amazon Cognito Identity Provider
  1. Root
Amazon Cognito Identity Provider
  • Root
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
  1. Root

/

POST
/
Describes the user import job.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string",
    "JobId": "string"
}'
Response Response Example
200 - Example 1
{
    "UserImportJob": {
        "JobName": "string",
        "JobId": "string",
        "UserPoolId": "string",
        "PreSignedUrl": "string",
        "CreationDate": "string",
        "StartDate": "string",
        "CompletionDate": "string",
        "Status": "Created",
        "CloudWatchLogsRoleArn": "string",
        "ImportedUsers": 0,
        "SkippedUsers": 0,
        "FailedUsers": 0,
        "CompletionMessage": "string"
    }
}

Request

Header Params
X-Amz-Target
string 
required
Body Params application/json
Represents the request to describe the user import job.
UserPoolId
string 
required
The user pool ID for the user pool that the users are being imported into.
>= 1 characters<= 55 characters
Match pattern:
[\w-]+_[0-9a-zA-Z]+
JobId
string 
required
The job ID for the user import job.
>= 1 characters<= 55 characters
Match pattern:
import-[0-9a-zA-Z-]+
Examples

Responses

🟢200Success
application/json
Body
Represents the response from the server to the request to describe the user import job.
UserImportJob
object 
optional
The job object that represents the user import job.
JobName
string 
optional
The job name for the user import job.
>= 1 characters<= 128 characters
Match pattern:
[\w\s+=,.@-]+
JobId
string 
optional
The job ID for the user import job.
>= 1 characters<= 55 characters
Match pattern:
import-[0-9a-zA-Z-]+
UserPoolId
string 
optional
The user pool ID for the user pool that the users are being imported into.
>= 1 characters<= 55 characters
Match pattern:
[\w-]+_[0-9a-zA-Z]+
PreSignedUrl
string 
optional
The pre-signed URL to be used to upload the .csv file.
>= 0 characters<= 2048 characters
CreationDate
string <date-time>
optional
The date the user import job was created.
StartDate
string <date-time>
optional
The date when the user import job was started.
CompletionDate
string <date-time>
optional
The date when the user import job was completed.
Status
enum<string> 
optional
The status of the user import job. One of the following:
  • Created - The job was created but not started.
  • Pending - A transition state. You have started the job, but it has not begun importing users yet.
  • InProgress - The job has started, and users are being imported.
  • Stopping - You have stopped the job, but the job has not stopped importing users yet.
  • Stopped - You have stopped the job, and the job has stopped importing users.
  • Succeeded - The job has completed successfully.
  • Failed - The job has stopped due to an error.
  • Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.
Allowed values:
CreatedPendingInProgressStoppingExpiredStoppedFailedSucceeded
CloudWatchLogsRoleArn
string 
optional
The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.
>= 20 characters<= 2048 characters
Match pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
ImportedUsers
integer 
optional
The number of users that were successfully imported.
SkippedUsers
integer 
optional
The number of users that were skipped.
FailedUsers
integer 
optional
The number of users that couldn't be imported.
CompletionMessage
string 
optional
The message returned when the user import job is completed.
>= 1 characters<= 128 characters
Match pattern:
[\w]+
🟠480ResourceNotFoundException
🟠481InvalidParameterException
🟠482TooManyRequestsException
🟠483NotAuthorizedException
🟠484InternalErrorException
Modified at 2023-08-15 07:11:07
Previous
/
Next
/
Built with