[ aws . cognito-idp ]
Gets the header information for the .csv file to be used as input for the user import job.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
get-csv-header
--user-pool-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--user-pool-id
(string)
The user pool ID for the user pool that the users are to be imported into.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To create a csv header
This example creates a csv header.
For more information about importing users, see Importing Users into User Pools From a CSV File.
Command:
aws cognito-idp get-csv-header --user-pool-id us-west-2_aaaaaaaaa
Output:
{
"UserPoolId": "us-west-2_aaaaaaaaa",
"CSVHeader": [
"name",
"given_name",
"family_name",
"middle_name",
"nickname",
"preferred_username",
"profile",
"picture",
"website",
"email",
"email_verified",
"gender",
"birthdate",
"zoneinfo",
"locale",
"phone_number",
"phone_number_verified",
"address",
"updated_at",
"cognito:mfa_enabled",
"cognito:username"
]
}
… Importing Users into User Pools From a CSV File: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html
UserPoolId -> (string)
The user pool ID for the user pool that the users are to be imported into.
CSVHeader -> (list)
The header information for the .csv file for the user import job.
(string)