Get Csv Header

cognitoidentityprovider_get_csv_header

R Documentation

Given a user pool ID, generates a comma-separated value (CSV) list populated with available user attributes in the user pool

Description

Given 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

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_get_csv_header(UserPoolId)

Arguments

UserPoolId

[required] The ID of the user pool that you want to import users into.

Value

A list with the following syntax:

list(
  UserPoolId = "string",
  CSVHeader = list(
    "string"
  )
)

Request syntax

svc$get_csv_header(
  UserPoolId = "string"
)