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.DescribeUserImportJob

Description

Describes the user import job.

Synopsis

Creating a Request

data DescribeUserImportJob Source #

Represents the request to describe the user import job.

See: newDescribeUserImportJob smart constructor.

Constructors

DescribeUserImportJob' 

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

Instances details
ToJSON DescribeUserImportJob Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Methods

toJSON :: DescribeUserImportJob -> Value #

toEncoding :: DescribeUserImportJob -> Encoding #

toJSONList :: [DescribeUserImportJob] -> Value #

toEncodingList :: [DescribeUserImportJob] -> Encoding #

ToHeaders DescribeUserImportJob Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Methods

toHeaders :: DescribeUserImportJob -> [Header] #

ToPath DescribeUserImportJob Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Methods

toPath :: DescribeUserImportJob -> ByteString #

ToQuery DescribeUserImportJob Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Methods

toQuery :: DescribeUserImportJob -> QueryString #

AWSRequest DescribeUserImportJob Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Associated Types

type AWSResponse DescribeUserImportJob #

Methods

request :: (Service -> Service) -> DescribeUserImportJob -> Request DescribeUserImportJob #

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

Generic DescribeUserImportJob Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Associated Types

type Rep DescribeUserImportJob :: Type -> Type #

Methods

from :: DescribeUserImportJob -> Rep DescribeUserImportJob x #

to :: Rep DescribeUserImportJob x -> DescribeUserImportJob #

Read DescribeUserImportJob Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Methods

readsPrec :: Int -> ReadS DescribeUserImportJob #

readList :: ReadS [DescribeUserImportJob] #

readPrec :: ReadPrec DescribeUserImportJob #

readListPrec :: ReadPrec [DescribeUserImportJob] #

Show DescribeUserImportJob Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Methods

showsPrec :: Int -> DescribeUserImportJob -> ShowS #

show :: DescribeUserImportJob -> String #

showList :: [DescribeUserImportJob] -> ShowS #

NFData DescribeUserImportJob Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Methods

rnf :: DescribeUserImportJob -> () #

Eq DescribeUserImportJob Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Methods

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

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

Hashable DescribeUserImportJob Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Methods

hashWithSalt :: Int -> DescribeUserImportJob -> Int #

hash :: DescribeUserImportJob -> Int #

type AWSResponse DescribeUserImportJob Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

type AWSResponse DescribeUserImportJob = DescribeUserImportJobResponse
type Rep DescribeUserImportJob Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

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

newDescribeUserImportJob Source #

Arguments

:: Text

DescribeUserImportJob

-> Text

DescribeUserImportJob

-> DescribeUserImportJob 

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

DescribeUserImportJob, describeUserImportJob_userPoolId - The user pool ID for the user pool that the users are being imported into.

DescribeUserImportJob, describeUserImportJob_jobId - The job ID for the user import job.

Request Lenses

describeUserImportJob_userPoolId :: Lens' DescribeUserImportJob Text Source #

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

describeUserImportJob_jobId :: Lens' DescribeUserImportJob Text Source #

The job ID for the user import job.

Destructuring the Response

data DescribeUserImportJobResponse Source #

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

See: newDescribeUserImportJobResponse smart constructor.

Constructors

DescribeUserImportJobResponse' 

Fields

Instances

Instances details
Generic DescribeUserImportJobResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Associated Types

type Rep DescribeUserImportJobResponse :: Type -> Type #

Methods

from :: DescribeUserImportJobResponse -> Rep DescribeUserImportJobResponse x #

to :: Rep DescribeUserImportJobResponse x -> DescribeUserImportJobResponse #

Read DescribeUserImportJobResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Methods

readsPrec :: Int -> ReadS DescribeUserImportJobResponse #

readList :: ReadS [DescribeUserImportJobResponse] #

readPrec :: ReadPrec DescribeUserImportJobResponse #

readListPrec :: ReadPrec [DescribeUserImportJobResponse] #

Show DescribeUserImportJobResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Methods

showsPrec :: Int -> DescribeUserImportJobResponse -> ShowS #

show :: DescribeUserImportJobResponse -> String #

showList :: [DescribeUserImportJobResponse] -> ShowS #

NFData DescribeUserImportJobResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Methods

rnf :: DescribeUserImportJobResponse -> () #

Eq DescribeUserImportJobResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

Methods

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

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

type Rep DescribeUserImportJobResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserImportJob

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

newDescribeUserImportJobResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeUserImportJobResponse'

-> DescribeUserImportJobResponse 

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

$sel:httpStatus:DescribeUserImportJobResponse', describeUserImportJobResponse_httpStatus - The response's http status code.

Response Lenses

describeUserImportJobResponse_userImportJob :: Lens' DescribeUserImportJobResponse (Maybe UserImportJobType) Source #

The job object that represents the user import job.

describeUserImportJobResponse_httpStatus :: Lens' DescribeUserImportJobResponse Int Source #

The response's http status code.