Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CognitoIdentityProvider.GetCSVHeader

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.

Synopsis

Creating a Request

data GetCSVHeader Source #

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

See: newGetCSVHeader smart constructor.

Constructors

GetCSVHeader'
Fields userPoolId :: Text The user pool ID for the user pool that the users are to be imported into.

Instances

Instances details

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

newGetCSVHeader Source #

Arguments

:: Text	`GetCSVHeader`
-> GetCSVHeader

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

GetCSVHeader, getCSVHeader_userPoolId - The user pool ID for the user pool that the users are to be imported into.

Request Lenses

getCSVHeader_userPoolId :: Lens' GetCSVHeader Text Source #

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

Destructuring the Response

data GetCSVHeaderResponse Source #

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

See: newGetCSVHeaderResponse smart constructor.

Constructors

GetCSVHeaderResponse'
Fields cSVHeader :: Maybe [Text] The header information of the CSV file for the user import job. userPoolId :: Maybe Text The user pool ID for the user pool that the users are to be imported into. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetCSVHeaderResponse Source #

Arguments

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

Create a value of GetCSVHeaderResponse 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:cSVHeader:GetCSVHeaderResponse', getCSVHeaderResponse_cSVHeader - The header information of the CSV file for the user import job.

GetCSVHeader, getCSVHeaderResponse_userPoolId - The user pool ID for the user pool that the users are to be imported into.

$sel:httpStatus:GetCSVHeaderResponse', getCSVHeaderResponse_httpStatus - The response's http status code.

Response Lenses

getCSVHeaderResponse_cSVHeader :: Lens' GetCSVHeaderResponse (Maybe [Text]) Source #

The header information of the CSV file for the user import job.

getCSVHeaderResponse_userPoolId :: Lens' GetCSVHeaderResponse (Maybe Text) Source #

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

getCSVHeaderResponse_httpStatus :: Lens' GetCSVHeaderResponse Int Source #

The response's http status code.