Smaws_Client_CognitoIdentityProvider.GetCSVHeaderGiven a user pool ID, generates a comma-separated value (CSV) list populated with available user attributes in the user pool. This list is the header for the CSV file that determines the users in a user import job. Save the content of CSVHeader in the response as a .csv file and populate it with the usernames and attributes of users that you want to import. For more information about CSV user import, see Importing users from a CSV file.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
val error_to_string :
[ Smaws_Lib.Protocols.AwsJson.error
| `InternalErrorException of Types.internal_error_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception ] ->
stringval request :
'http_type Smaws_Lib.Context.t ->
Types.get_csv_header_request ->
(Types.get_csv_header_response,
[> Smaws_Lib.Protocols.AwsJson.error
| `InternalErrorException of Types.internal_error_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception ])
Stdlib.resultval request_with_metadata :
'http_type Smaws_Lib.Context.t ->
Types.get_csv_header_request ->
(Types.get_csv_header_response Smaws_Lib.Response.t,
[> Smaws_Lib.Protocols.AwsJson.error
| `InternalErrorException of Types.internal_error_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception ]
* Smaws_Lib.Response.metadata)
Stdlib.result