Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.CognitoIdentityProvider.GetCSVHeader

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the header information for the .csv file to be used as input for the user import job.

Synopsis

Creating a Request

getCSVHeader #

Arguments

:: Text	`gchUserPoolId`
-> GetCSVHeader

Creates a value of GetCSVHeader with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gchUserPoolId - The user pool ID for the user pool that the users are to be imported into.

data GetCSVHeader #

Represents the request to get the header information for the .csv file for the user import job.

See: getCSVHeader smart constructor.

Instances

Eq GetCSVHeader #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods (==) :: GetCSVHeader -> GetCSVHeader -> Bool # (/=) :: GetCSVHeader -> GetCSVHeader -> Bool #
Data GetCSVHeader #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetCSVHeader -> c GetCSVHeader # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetCSVHeader # toConstr :: GetCSVHeader -> Constr # dataTypeOf :: GetCSVHeader -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetCSVHeader) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetCSVHeader) # gmapT :: (forall b. Data b => b -> b) -> GetCSVHeader -> GetCSVHeader # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetCSVHeader -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetCSVHeader -> r # gmapQ :: (forall d. Data d => d -> u) -> GetCSVHeader -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetCSVHeader -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetCSVHeader -> m GetCSVHeader # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetCSVHeader -> m GetCSVHeader # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetCSVHeader -> m GetCSVHeader #
Read GetCSVHeader #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods readsPrec :: Int -> ReadS GetCSVHeader # readList :: ReadS [GetCSVHeader] # readPrec :: ReadPrec GetCSVHeader # readListPrec :: ReadPrec [GetCSVHeader] #
Show GetCSVHeader #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods showsPrec :: Int -> GetCSVHeader -> ShowS # show :: GetCSVHeader -> String # showList :: [GetCSVHeader] -> ShowS #
Generic GetCSVHeader #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Associated Types type Rep GetCSVHeader :: * -> * # Methods from :: GetCSVHeader -> Rep GetCSVHeader x # to :: Rep GetCSVHeader x -> GetCSVHeader #
Hashable GetCSVHeader #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods hashWithSalt :: Int -> GetCSVHeader -> Int # hash :: GetCSVHeader -> Int #
ToJSON GetCSVHeader #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods toJSON :: GetCSVHeader -> Value # toEncoding :: GetCSVHeader -> Encoding # toJSONList :: [GetCSVHeader] -> Value # toEncodingList :: [GetCSVHeader] -> Encoding #
AWSRequest GetCSVHeader #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Associated Types type Rs GetCSVHeader :: * # Methods request :: GetCSVHeader -> Request GetCSVHeader # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetCSVHeader -> ClientResponse -> m (Response GetCSVHeader) #
ToHeaders GetCSVHeader #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods toHeaders :: GetCSVHeader -> [Header] #
ToPath GetCSVHeader #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods toPath :: GetCSVHeader -> ByteString #
ToQuery GetCSVHeader #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods toQuery :: GetCSVHeader -> QueryString #
NFData GetCSVHeader #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods rnf :: GetCSVHeader -> () #
type Rep GetCSVHeader #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader type Rep GetCSVHeader = D1 (MetaData "GetCSVHeader" "Network.AWS.CognitoIdentityProvider.GetCSVHeader" "amazonka-cognito-idp-1.6.0-7SljkxAhdrGDTNozW2RuYv" True) (C1 (MetaCons "GetCSVHeader'" PrefixI True) (S1 (MetaSel (Just "_gchUserPoolId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs GetCSVHeader #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader type Rs GetCSVHeader = GetCSVHeaderResponse

Request Lenses

gchUserPoolId :: Lens' GetCSVHeader Text #

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

Destructuring the Response

getCSVHeaderResponse #

Arguments

:: Int	`gchrsResponseStatus`
-> GetCSVHeaderResponse

Creates a value of GetCSVHeaderResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gchrsUserPoolId - The user pool ID for the user pool that the users are to be imported into.
gchrsCSVHeader - The header information for the .csv file for the user import job.
gchrsResponseStatus - -- | The response status code.

data GetCSVHeaderResponse #

Represents the response from the server to the request to get the header information for the .csv file for the user import job.

See: getCSVHeaderResponse smart constructor.

Instances

Eq GetCSVHeaderResponse #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods (==) :: GetCSVHeaderResponse -> GetCSVHeaderResponse -> Bool # (/=) :: GetCSVHeaderResponse -> GetCSVHeaderResponse -> Bool #
Data GetCSVHeaderResponse #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetCSVHeaderResponse -> c GetCSVHeaderResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetCSVHeaderResponse # toConstr :: GetCSVHeaderResponse -> Constr # dataTypeOf :: GetCSVHeaderResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetCSVHeaderResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetCSVHeaderResponse) # gmapT :: (forall b. Data b => b -> b) -> GetCSVHeaderResponse -> GetCSVHeaderResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetCSVHeaderResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetCSVHeaderResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GetCSVHeaderResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetCSVHeaderResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetCSVHeaderResponse -> m GetCSVHeaderResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetCSVHeaderResponse -> m GetCSVHeaderResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetCSVHeaderResponse -> m GetCSVHeaderResponse #
Read GetCSVHeaderResponse #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods readsPrec :: Int -> ReadS GetCSVHeaderResponse # readList :: ReadS [GetCSVHeaderResponse] # readPrec :: ReadPrec GetCSVHeaderResponse # readListPrec :: ReadPrec [GetCSVHeaderResponse] #
Show GetCSVHeaderResponse #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods showsPrec :: Int -> GetCSVHeaderResponse -> ShowS # show :: GetCSVHeaderResponse -> String # showList :: [GetCSVHeaderResponse] -> ShowS #
Generic GetCSVHeaderResponse #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Associated Types type Rep GetCSVHeaderResponse :: * -> * # Methods from :: GetCSVHeaderResponse -> Rep GetCSVHeaderResponse x # to :: Rep GetCSVHeaderResponse x -> GetCSVHeaderResponse #
NFData GetCSVHeaderResponse #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader Methods rnf :: GetCSVHeaderResponse -> () #
type Rep GetCSVHeaderResponse #
Instance details Defined in Network.AWS.CognitoIdentityProvider.GetCSVHeader type Rep GetCSVHeaderResponse = D1 (MetaData "GetCSVHeaderResponse" "Network.AWS.CognitoIdentityProvider.GetCSVHeader" "amazonka-cognito-idp-1.6.0-7SljkxAhdrGDTNozW2RuYv" False) (C1 (MetaCons "GetCSVHeaderResponse'" PrefixI True) (S1 (MetaSel (Just "_gchrsUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_gchrsCSVHeader") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_gchrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

gchrsUserPoolId :: Lens' GetCSVHeaderResponse (Maybe Text) #

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

gchrsCSVHeader :: Lens' GetCSVHeaderResponse [Text] #

The header information for the .csv file for the user import job.

gchrsResponseStatus :: Lens' GetCSVHeaderResponse Int #

- | The response status code.