/ - Amazon Cognito Identity Provider

curl --location --request POST '/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "UserPoolId": "string", "MaxResults": 0, "PaginationToken": "string" }'

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Represents the request to list the user import jobs.

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]+

MaxResults

integer

required

The maximum number of import jobs you want the request to return.

>= 1<= 60

PaginationToken

string

optional

An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.

>= 1 characters

Match pattern:

[\S]+

Examples

Responses

🟢200Success

application/json

Body

Represents the response from the server to the request to list the user import jobs.

UserImportJobs

array[object (UserImportJobType) {13}]

optional

The user import jobs.

>= 1 items<= 50 items

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]+

PaginationToken

string

optional

An identifier that can be used to return the next set of user import jobs in the list.

>= 1 characters

Match pattern:

[\S]+

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482TooManyRequestsException

🟠483NotAuthorizedException

🟠484InternalErrorException