amazonka-cognito-idp-2.0: Amazon Cognito Identity Provider SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CognitoIdentityProvider.Types.UserImportJobType

Description

 
Synopsis

Documentation

data UserImportJobType Source #

The user import job type.

See: newUserImportJobType smart constructor.

Constructors

UserImportJobType' 

Fields

  • cloudWatchLogsRoleArn :: Maybe Text

    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.

  • completionDate :: Maybe POSIX

    The date when the user import job was completed.

  • completionMessage :: Maybe Text

    The message returned when the user import job is completed.

  • creationDate :: Maybe POSIX

    The date the user import job was created.

  • failedUsers :: Maybe Integer

    The number of users that couldn't be imported.

  • importedUsers :: Maybe Integer

    The number of users that were successfully imported.

  • jobId :: Maybe Text

    The job ID for the user import job.

  • jobName :: Maybe Text

    The job name for the user import job.

  • preSignedUrl :: Maybe Text

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

  • skippedUsers :: Maybe Integer

    The number of users that were skipped.

  • startDate :: Maybe POSIX

    The date when the user import job was started.

  • status :: Maybe UserImportJobStatusType

    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.
  • userPoolId :: Maybe Text

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

Instances

Instances details
FromJSON UserImportJobType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.UserImportJobType

Methods

parseJSON :: Value -> Parser UserImportJobType #

parseJSONList :: Value -> Parser [UserImportJobType] #

Generic UserImportJobType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.UserImportJobType

Associated Types

type Rep UserImportJobType :: Type -> Type #

Methods

from :: UserImportJobType -> Rep UserImportJobType x #

to :: Rep UserImportJobType x -> UserImportJobType #

Read UserImportJobType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.UserImportJobType

Methods

readsPrec :: Int -> ReadS UserImportJobType #

readList :: ReadS [UserImportJobType] #

readPrec :: ReadPrec UserImportJobType #

readListPrec :: ReadPrec [UserImportJobType] #

Show UserImportJobType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.UserImportJobType

Methods

showsPrec :: Int -> UserImportJobType -> ShowS #

show :: UserImportJobType -> String #

showList :: [UserImportJobType] -> ShowS #

NFData UserImportJobType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.UserImportJobType

Methods

rnf :: UserImportJobType -> () #

Eq UserImportJobType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.UserImportJobType

Methods

(==) :: UserImportJobType -> UserImportJobType -> Bool #

(/=) :: UserImportJobType -> UserImportJobType -> Bool #

Hashable UserImportJobType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.UserImportJobType

Methods

hashWithSalt :: Int -> UserImportJobType -> Int #

hash :: UserImportJobType -> Int #

type Rep UserImportJobType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.UserImportJobType

type Rep UserImportJobType = D1 ('MetaData "UserImportJobType" "Amazonka.CognitoIdentityProvider.Types.UserImportJobType" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "UserImportJobType'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudWatchLogsRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "completionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "completionMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "failedUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "importedUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :*: ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "preSignedUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "skippedUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserImportJobStatusType)) :*: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newUserImportJobType :: UserImportJobType Source #

Create a value of UserImportJobType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cloudWatchLogsRoleArn:UserImportJobType', userImportJobType_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.

$sel:completionDate:UserImportJobType', userImportJobType_completionDate - The date when the user import job was completed.

$sel:completionMessage:UserImportJobType', userImportJobType_completionMessage - The message returned when the user import job is completed.

$sel:creationDate:UserImportJobType', userImportJobType_creationDate - The date the user import job was created.

$sel:failedUsers:UserImportJobType', userImportJobType_failedUsers - The number of users that couldn't be imported.

$sel:importedUsers:UserImportJobType', userImportJobType_importedUsers - The number of users that were successfully imported.

$sel:jobId:UserImportJobType', userImportJobType_jobId - The job ID for the user import job.

$sel:jobName:UserImportJobType', userImportJobType_jobName - The job name for the user import job.

$sel:preSignedUrl:UserImportJobType', userImportJobType_preSignedUrl - The pre-signed URL to be used to upload the .csv file.

$sel:skippedUsers:UserImportJobType', userImportJobType_skippedUsers - The number of users that were skipped.

$sel:startDate:UserImportJobType', userImportJobType_startDate - The date when the user import job was started.

$sel:status:UserImportJobType', userImportJobType_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.

$sel:userPoolId:UserImportJobType', userImportJobType_userPoolId - The user pool ID for the user pool that the users are being imported into.

userImportJobType_cloudWatchLogsRoleArn :: Lens' UserImportJobType (Maybe Text) Source #

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.

userImportJobType_completionDate :: Lens' UserImportJobType (Maybe UTCTime) Source #

The date when the user import job was completed.

userImportJobType_completionMessage :: Lens' UserImportJobType (Maybe Text) Source #

The message returned when the user import job is completed.

userImportJobType_creationDate :: Lens' UserImportJobType (Maybe UTCTime) Source #

The date the user import job was created.

userImportJobType_failedUsers :: Lens' UserImportJobType (Maybe Integer) Source #

The number of users that couldn't be imported.

userImportJobType_importedUsers :: Lens' UserImportJobType (Maybe Integer) Source #

The number of users that were successfully imported.

userImportJobType_jobId :: Lens' UserImportJobType (Maybe Text) Source #

The job ID for the user import job.

userImportJobType_jobName :: Lens' UserImportJobType (Maybe Text) Source #

The job name for the user import job.

userImportJobType_preSignedUrl :: Lens' UserImportJobType (Maybe Text) Source #

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

userImportJobType_skippedUsers :: Lens' UserImportJobType (Maybe Integer) Source #

The number of users that were skipped.

userImportJobType_startDate :: Lens' UserImportJobType (Maybe UTCTime) Source #

The date when the user import job was started.

userImportJobType_status :: Lens' UserImportJobType (Maybe UserImportJobStatusType) Source #

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.

userImportJobType_userPoolId :: Lens' UserImportJobType (Maybe Text) Source #

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