AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The user import job type.

Inheritance Hierarchy

System.Object
  Amazon.CognitoIdentityProvider.Model.UserImportJobType

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C# 
public class UserImportJobType

The UserImportJobType type exposes the following members

Constructors

NameDescription
Public Method UserImportJobType()

Properties

NameTypeDescription
Public Property CloudWatchLogsRoleArn System.String

Gets and sets the property CloudWatchLogsRoleArn.

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.

Public Property CompletionDate System.DateTime

Gets and sets the property CompletionDate.

The date when the user import job was completed.

Public Property CompletionMessage System.String

Gets and sets the property CompletionMessage.

The message returned when the user import job is completed.

Public Property CreationDate System.DateTime

Gets and sets the property CreationDate.

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Public Property FailedUsers System.Int64

Gets and sets the property FailedUsers.

The number of users that couldn't be imported.

Public Property ImportedUsers System.Int64

Gets and sets the property ImportedUsers.

The number of users that were successfully imported.

Public Property JobId System.String

Gets and sets the property JobId.

The job ID for the user import job.

Public Property JobName System.String

Gets and sets the property JobName.

The job name for the user import job.

Public Property PreSignedUrl System.String

Gets and sets the property PreSignedUrl.

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

Public Property SkippedUsers System.Int64

Gets and sets the property SkippedUsers.

The number of users that were skipped.

Public Property StartDate System.DateTime

Gets and sets the property StartDate.

The date when the user import job was started.

Public Property Status Amazon.CognitoIdentityProvider.UserImportJobStatusType

Gets and sets the property Status.

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.

Public Property UserPoolId System.String

Gets and sets the property UserPoolId.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5