Amazonka.CognitoIdentityProvider.CreateUserImportJob

Creates the user import job.

Creating a Request

data CreateUserImportJob

Represents the request to create the user import job.

See: newCreateUserImportJob smart constructor.

Constructors

CreateUserImportJob'

Fields

• jobName :: Text

  The job name for the user import job.

• userPoolId :: Text

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

• cloudWatchLogsRoleArn :: Text

  The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.

Instances

ToJSON CreateUserImportJob

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Methods

toJSON :: CreateUserImportJob -> Value

toEncoding :: CreateUserImportJob -> Encoding

toJSONList :: [CreateUserImportJob] -> Value

toEncodingList :: [CreateUserImportJob] -> Encoding

ToHeaders CreateUserImportJob

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Methods

toHeaders :: CreateUserImportJob -> [Header]

ToPath CreateUserImportJob

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Methods

toPath :: CreateUserImportJob -> ByteString

ToQuery CreateUserImportJob

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Methods

toQuery :: CreateUserImportJob -> QueryString

AWSRequest CreateUserImportJob

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Associated Types

type AWSResponse CreateUserImportJob

Methods

request :: (Service -> Service) -> CreateUserImportJob -> Request CreateUserImportJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateUserImportJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateUserImportJob)))

Generic CreateUserImportJob

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Associated Types

type Rep CreateUserImportJob :: Type -> Type

Methods

from :: CreateUserImportJob -> Rep CreateUserImportJob x

to :: Rep CreateUserImportJob x -> CreateUserImportJob

Read CreateUserImportJob

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Methods

readsPrec :: Int -> ReadS CreateUserImportJob

readList :: ReadS [CreateUserImportJob]

readPrec :: ReadPrec CreateUserImportJob

readListPrec :: ReadPrec [CreateUserImportJob]

Show CreateUserImportJob

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Methods

showsPrec :: Int -> CreateUserImportJob -> ShowS

show :: CreateUserImportJob -> String

showList :: [CreateUserImportJob] -> ShowS

NFData CreateUserImportJob

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Methods

rnf :: CreateUserImportJob -> ()

Eq CreateUserImportJob

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Methods

(==) :: CreateUserImportJob -> CreateUserImportJob -> Bool

(/=) :: CreateUserImportJob -> CreateUserImportJob -> Bool

Hashable CreateUserImportJob

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Methods

hashWithSalt :: Int -> CreateUserImportJob -> Int

hash :: CreateUserImportJob -> Int

type AWSResponse CreateUserImportJob

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

type AWSResponse CreateUserImportJob = CreateUserImportJobResponse

type Rep CreateUserImportJob

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

type Rep CreateUserImportJob = D1 ('MetaData "CreateUserImportJob" "Amazonka.CognitoIdentityProvider.CreateUserImportJob" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "CreateUserImportJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "cloudWatchLogsRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateUserImportJob

Arguments

:: Text

CreateUserImportJob

-> Text

CreateUserImportJob

-> Text

CreateUserImportJob

-> CreateUserImportJob

Create a value of CreateUserImportJob 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:

CreateUserImportJob, createUserImportJob_jobName - The job name for the user import job.

CreateUserImportJob, createUserImportJob_userPoolId - The user pool ID for the user pool that the users are being imported into.

CreateUserImportJob, createUserImportJob_cloudWatchLogsRoleArn - The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.

Request Lenses

createUserImportJob_jobName :: Lens' CreateUserImportJob Text

The job name for the user import job.

createUserImportJob_userPoolId :: Lens' CreateUserImportJob Text

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

createUserImportJob_cloudWatchLogsRoleArn :: Lens' CreateUserImportJob Text

The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.

Destructuring the Response

data CreateUserImportJobResponse

Represents the response from the server to the request to create the user import job.

See: newCreateUserImportJobResponse smart constructor.

Constructors

CreateUserImportJobResponse'

Fields

• userImportJob :: Maybe UserImportJobType

  The job object that represents the user import job.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateUserImportJobResponse

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Associated Types

type Rep CreateUserImportJobResponse :: Type -> Type

Methods

from :: CreateUserImportJobResponse -> Rep CreateUserImportJobResponse x

to :: Rep CreateUserImportJobResponse x -> CreateUserImportJobResponse

Read CreateUserImportJobResponse

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Methods

readsPrec :: Int -> ReadS CreateUserImportJobResponse

readList :: ReadS [CreateUserImportJobResponse]

readPrec :: ReadPrec CreateUserImportJobResponse

readListPrec :: ReadPrec [CreateUserImportJobResponse]

Show CreateUserImportJobResponse

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Methods

showsPrec :: Int -> CreateUserImportJobResponse -> ShowS

show :: CreateUserImportJobResponse -> String

showList :: [CreateUserImportJobResponse] -> ShowS

NFData CreateUserImportJobResponse

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Methods

rnf :: CreateUserImportJobResponse -> ()

Eq CreateUserImportJobResponse

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

Methods

(==) :: CreateUserImportJobResponse -> CreateUserImportJobResponse -> Bool

(/=) :: CreateUserImportJobResponse -> CreateUserImportJobResponse -> Bool

type Rep CreateUserImportJobResponse

Defined in Amazonka.CognitoIdentityProvider.CreateUserImportJob

type Rep CreateUserImportJobResponse = D1 ('MetaData "CreateUserImportJobResponse" "Amazonka.CognitoIdentityProvider.CreateUserImportJob" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "CreateUserImportJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userImportJob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserImportJobType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateUserImportJobResponse

Arguments

:: Int

$sel:httpStatus:CreateUserImportJobResponse'

-> CreateUserImportJobResponse

Create a value of CreateUserImportJobResponse 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:userImportJob:CreateUserImportJobResponse', createUserImportJobResponse_userImportJob - The job object that represents the user import job.

$sel:httpStatus:CreateUserImportJobResponse', createUserImportJobResponse_httpStatus - The response's http status code.

Response Lenses

createUserImportJobResponse_userImportJob :: Lens' CreateUserImportJobResponse (Maybe UserImportJobType)

The job object that represents the user import job.

createUserImportJobResponse_httpStatus :: Lens' CreateUserImportJobResponse Int

The response's http status code.