NAME

Paws::CognitoIdp::UserImportJobType

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::CognitoIdp::UserImportJobType object:

  $service_obj->Method(Att1 => { CloudWatchLogsRoleArn => $value, ..., UserPoolId => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::UserImportJobType object:

  $result = $service_obj->Method(...);
  $result->Att1->CloudWatchLogsRoleArn

DESCRIPTION

The user import job type.

ATTRIBUTES

CloudWatchLogsRoleArn => Str

  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 => Str

  The date when the user import job was completed.

CompletionMessage => Str

  The message returned when the user import job is completed.

CreationDate => Str

  The date the user import job was created.

FailedUsers => Int

  The number of users that could not be imported.

ImportedUsers => Int

  The number of users that were successfully imported.

JobId => Str

  The job ID for the user import job.

JobName => Str

  The job name for the user import job.

PreSignedUrl => Str

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

SkippedUsers => Int

  The number of users that were skipped.

StartDate => Str

  The date when the user import job was started.

Status => Str

  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 => Str

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

SEE ALSO

This class forms part of Paws, describing an object used in Paws::CognitoIdp

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues