Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

UserImportJobType

import type { UserImportJobType } from "https://aws-api.deno.dev/v0.3/services/cognitoidentityserviceprovider.ts?docs=full";

The user import job type.

interface UserImportJobType {
CloudWatchLogsRoleArn?: string | null;
CompletionDate?: Date | number | null;
CompletionMessage?: string | null;
CreationDate?: Date | number | null;
FailedUsers?: number | null;
ImportedUsers?: number | null;
JobId?: string | null;
JobName?: string | null;
PreSignedUrl?: string | null;
SkippedUsers?: number | null;
StartDate?: Date | number | null;
Status?: UserImportJobStatusType | null;
UserPoolId?: string | null;
}

§Properties

§
CloudWatchLogsRoleArn?: string | null
[src]

The role 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.

§
CompletionDate?: Date | number | null
[src]

The date when the user import job was completed.

§
CompletionMessage?: string | null
[src]

The message returned when the user import job is completed.

§
CreationDate?: Date | number | null
[src]

The date the user import job was created.

§
FailedUsers?: number | null
[src]

The number of users that could not be imported.

§
ImportedUsers?: number | null
[src]

The number of users that were successfully imported.

§
JobId?: string | null
[src]

The job ID for the user import job.

§
JobName?: string | null
[src]

The job name for the user import job.

§
PreSignedUrl?: string | null
[src]

The pre-signed URL to be used to upload the .csv file.

§
SkippedUsers?: number | null
[src]

The number of users that were skipped.

§
StartDate?: Date | number | null
[src]

The date when the user import job was started.

§

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 cannot be started.
§
UserPoolId?: string | null
[src]

The user pool ID for the user pool that the users are being imported into.