Amazonka.CognitoIdentityProvider.StartUserImportJob

Starts the user import.

Creating a Request

data StartUserImportJob

Represents the request to start the user import job.

See: newStartUserImportJob smart constructor.

Constructors

StartUserImportJob'

Fields

• userPoolId :: Text

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

• jobId :: Text

  The job ID for the user import job.

Instances

ToJSON StartUserImportJob

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Methods

toJSON :: StartUserImportJob -> Value

toEncoding :: StartUserImportJob -> Encoding

toJSONList :: [StartUserImportJob] -> Value

toEncodingList :: [StartUserImportJob] -> Encoding

ToHeaders StartUserImportJob

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Methods

toHeaders :: StartUserImportJob -> [Header]

ToPath StartUserImportJob

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Methods

toPath :: StartUserImportJob -> ByteString

ToQuery StartUserImportJob

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Methods

toQuery :: StartUserImportJob -> QueryString

AWSRequest StartUserImportJob

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Associated Types

type AWSResponse StartUserImportJob

Methods

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

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

Generic StartUserImportJob

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Associated Types

type Rep StartUserImportJob :: Type -> Type

Methods

from :: StartUserImportJob -> Rep StartUserImportJob x

to :: Rep StartUserImportJob x -> StartUserImportJob

Read StartUserImportJob

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Methods

readsPrec :: Int -> ReadS StartUserImportJob

readList :: ReadS [StartUserImportJob]

readPrec :: ReadPrec StartUserImportJob

readListPrec :: ReadPrec [StartUserImportJob]

Show StartUserImportJob

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Methods

showsPrec :: Int -> StartUserImportJob -> ShowS

show :: StartUserImportJob -> String

showList :: [StartUserImportJob] -> ShowS

NFData StartUserImportJob

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Methods

rnf :: StartUserImportJob -> ()

Eq StartUserImportJob

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Methods

(==) :: StartUserImportJob -> StartUserImportJob -> Bool

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

Hashable StartUserImportJob

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Methods

hashWithSalt :: Int -> StartUserImportJob -> Int

hash :: StartUserImportJob -> Int

type AWSResponse StartUserImportJob

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

type AWSResponse StartUserImportJob = StartUserImportJobResponse

type Rep StartUserImportJob

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

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

newStartUserImportJob

Arguments

:: Text

StartUserImportJob

-> Text

StartUserImportJob

-> StartUserImportJob

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

StartUserImportJob, startUserImportJob_userPoolId - The user pool ID for the user pool that the users are being imported into.

StartUserImportJob, startUserImportJob_jobId - The job ID for the user import job.

Request Lenses

startUserImportJob_userPoolId :: Lens' StartUserImportJob Text

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

startUserImportJob_jobId :: Lens' StartUserImportJob Text

The job ID for the user import job.

Destructuring the Response

data StartUserImportJobResponse

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

See: newStartUserImportJobResponse smart constructor.

Constructors

StartUserImportJobResponse'

Fields

• userImportJob :: Maybe UserImportJobType

  The job object that represents the user import job.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartUserImportJobResponse

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Associated Types

type Rep StartUserImportJobResponse :: Type -> Type

Methods

from :: StartUserImportJobResponse -> Rep StartUserImportJobResponse x

to :: Rep StartUserImportJobResponse x -> StartUserImportJobResponse

Read StartUserImportJobResponse

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Methods

readsPrec :: Int -> ReadS StartUserImportJobResponse

readList :: ReadS [StartUserImportJobResponse]

readPrec :: ReadPrec StartUserImportJobResponse

readListPrec :: ReadPrec [StartUserImportJobResponse]

Show StartUserImportJobResponse

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Methods

showsPrec :: Int -> StartUserImportJobResponse -> ShowS

show :: StartUserImportJobResponse -> String

showList :: [StartUserImportJobResponse] -> ShowS

NFData StartUserImportJobResponse

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Methods

rnf :: StartUserImportJobResponse -> ()

Eq StartUserImportJobResponse

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

Methods

(==) :: StartUserImportJobResponse -> StartUserImportJobResponse -> Bool

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

type Rep StartUserImportJobResponse

Defined in Amazonka.CognitoIdentityProvider.StartUserImportJob

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

newStartUserImportJobResponse

Arguments

:: Int

$sel:httpStatus:StartUserImportJobResponse'

-> StartUserImportJobResponse

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

$sel:httpStatus:StartUserImportJobResponse', startUserImportJobResponse_httpStatus - The response's http status code.

Response Lenses

startUserImportJobResponse_userImportJob :: Lens' StartUserImportJobResponse (Maybe UserImportJobType)

The job object that represents the user import job.

startUserImportJobResponse_httpStatus :: Lens' StartUserImportJobResponse Int

The response's http status code.