Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CognitoIdentityProvider.ListUserImportJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the user import jobs.

Synopsis

data ListUserImportJobs = ListUserImportJobs' {
- paginationToken :: Maybe Text
- userPoolId :: Text
- maxResults :: Natural
}
newListUserImportJobs :: Text -> Natural -> ListUserImportJobs
listUserImportJobs_paginationToken :: Lens' ListUserImportJobs (Maybe Text)
listUserImportJobs_userPoolId :: Lens' ListUserImportJobs Text
listUserImportJobs_maxResults :: Lens' ListUserImportJobs Natural
data ListUserImportJobsResponse = ListUserImportJobsResponse' {
- paginationToken :: Maybe Text
- userImportJobs :: Maybe (NonEmpty UserImportJobType)
- httpStatus :: Int
}
newListUserImportJobsResponse :: Int -> ListUserImportJobsResponse
listUserImportJobsResponse_paginationToken :: Lens' ListUserImportJobsResponse (Maybe Text)
listUserImportJobsResponse_userImportJobs :: Lens' ListUserImportJobsResponse (Maybe (NonEmpty UserImportJobType))
listUserImportJobsResponse_httpStatus :: Lens' ListUserImportJobsResponse Int

Creating a Request

data ListUserImportJobs Source #

Represents the request to list the user import jobs.

See: newListUserImportJobs smart constructor.

Constructors

ListUserImportJobs'
Fields paginationToken :: Maybe Text An identifier that was returned from the previous call to `ListUserImportJobs`, which can be used to return the next set of import jobs in the list. userPoolId :: Text The user pool ID for the user pool that the users are being imported into. maxResults :: Natural The maximum number of import jobs you want the request to return.

Instances

Instances details

Eq ListUserImportJobs Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Methods (==) :: ListUserImportJobs -> ListUserImportJobs -> Bool # (/=) :: ListUserImportJobs -> ListUserImportJobs -> Bool #
Read ListUserImportJobs Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Methods readsPrec :: Int -> ReadS ListUserImportJobs # readList :: ReadS [ListUserImportJobs] # readPrec :: ReadPrec ListUserImportJobs # readListPrec :: ReadPrec [ListUserImportJobs] #
Show ListUserImportJobs Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Methods showsPrec :: Int -> ListUserImportJobs -> ShowS # show :: ListUserImportJobs -> String # showList :: [ListUserImportJobs] -> ShowS #
Generic ListUserImportJobs Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Associated Types type Rep ListUserImportJobs :: Type -> Type # Methods from :: ListUserImportJobs -> Rep ListUserImportJobs x # to :: Rep ListUserImportJobs x -> ListUserImportJobs #
NFData ListUserImportJobs Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Methods rnf :: ListUserImportJobs -> () #
Hashable ListUserImportJobs Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Methods hashWithSalt :: Int -> ListUserImportJobs -> Int # hash :: ListUserImportJobs -> Int #
ToJSON ListUserImportJobs Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Methods toJSON :: ListUserImportJobs -> Value # toEncoding :: ListUserImportJobs -> Encoding # toJSONList :: [ListUserImportJobs] -> Value # toEncodingList :: [ListUserImportJobs] -> Encoding #
AWSRequest ListUserImportJobs Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Associated Types type AWSResponse ListUserImportJobs # Methods request :: ListUserImportJobs -> Request ListUserImportJobs # response :: MonadResource m => Logger -> Service -> Proxy ListUserImportJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListUserImportJobs))) #
ToHeaders ListUserImportJobs Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Methods toHeaders :: ListUserImportJobs -> [Header] #
ToPath ListUserImportJobs Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Methods toPath :: ListUserImportJobs -> ByteString #
ToQuery ListUserImportJobs Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Methods toQuery :: ListUserImportJobs -> QueryString #
type Rep ListUserImportJobs Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs type Rep ListUserImportJobs = D1 ('MetaData "ListUserImportJobs" "Amazonka.CognitoIdentityProvider.ListUserImportJobs" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "ListUserImportJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "paginationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))
type AWSResponse ListUserImportJobs Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs type AWSResponse ListUserImportJobs = ListUserImportJobsResponse

newListUserImportJobs Source #

Arguments

:: Text	`$sel:userPoolId:ListUserImportJobs'`
-> Natural	`$sel:maxResults:ListUserImportJobs'`
-> ListUserImportJobs

Create a value of ListUserImportJobs 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:paginationToken:ListUserImportJobs', listUserImportJobs_paginationToken - An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.

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

$sel:maxResults:ListUserImportJobs', listUserImportJobs_maxResults - The maximum number of import jobs you want the request to return.

Request Lenses

listUserImportJobs_paginationToken :: Lens' ListUserImportJobs (Maybe Text) Source #

An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.

listUserImportJobs_userPoolId :: Lens' ListUserImportJobs Text Source #

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

listUserImportJobs_maxResults :: Lens' ListUserImportJobs Natural Source #

The maximum number of import jobs you want the request to return.

Destructuring the Response

data ListUserImportJobsResponse Source #

Represents the response from the server to the request to list the user import jobs.

See: newListUserImportJobsResponse smart constructor.

Constructors

ListUserImportJobsResponse'
Fields paginationToken :: Maybe Text An identifier that can be used to return the next set of user import jobs in the list. userImportJobs :: Maybe (NonEmpty UserImportJobType) The user import jobs. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListUserImportJobsResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Methods (==) :: ListUserImportJobsResponse -> ListUserImportJobsResponse -> Bool # (/=) :: ListUserImportJobsResponse -> ListUserImportJobsResponse -> Bool #
Read ListUserImportJobsResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Methods readsPrec :: Int -> ReadS ListUserImportJobsResponse # readList :: ReadS [ListUserImportJobsResponse] # readPrec :: ReadPrec ListUserImportJobsResponse # readListPrec :: ReadPrec [ListUserImportJobsResponse] #
Show ListUserImportJobsResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Methods showsPrec :: Int -> ListUserImportJobsResponse -> ShowS # show :: ListUserImportJobsResponse -> String # showList :: [ListUserImportJobsResponse] -> ShowS #
Generic ListUserImportJobsResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Associated Types type Rep ListUserImportJobsResponse :: Type -> Type # Methods from :: ListUserImportJobsResponse -> Rep ListUserImportJobsResponse x # to :: Rep ListUserImportJobsResponse x -> ListUserImportJobsResponse #
NFData ListUserImportJobsResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs Methods rnf :: ListUserImportJobsResponse -> () #
type Rep ListUserImportJobsResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserImportJobs type Rep ListUserImportJobsResponse = D1 ('MetaData "ListUserImportJobsResponse" "Amazonka.CognitoIdentityProvider.ListUserImportJobs" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "ListUserImportJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "paginationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "userImportJobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty UserImportJobType))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListUserImportJobsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListUserImportJobsResponse'`
-> ListUserImportJobsResponse

Create a value of ListUserImportJobsResponse 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:paginationToken:ListUserImportJobs', listUserImportJobsResponse_paginationToken - An identifier that can be used to return the next set of user import jobs in the list.

$sel:userImportJobs:ListUserImportJobsResponse', listUserImportJobsResponse_userImportJobs - The user import jobs.

$sel:httpStatus:ListUserImportJobsResponse', listUserImportJobsResponse_httpStatus - The response's http status code.

Response Lenses

listUserImportJobsResponse_paginationToken :: Lens' ListUserImportJobsResponse (Maybe Text) Source #

An identifier that can be used to return the next set of user import jobs in the list.

listUserImportJobsResponse_userImportJobs :: Lens' ListUserImportJobsResponse (Maybe (NonEmpty UserImportJobType)) Source #

The user import jobs.

listUserImportJobsResponse_httpStatus :: Lens' ListUserImportJobsResponse Int Source #

The response's http status code.