GetCSVHeaderRequest

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

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name	Type	Description
UserPoolId	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/user-pools-get-csv-header-request-schema.json",
  "title": "GetCSVHeaderRequest",
  "description": "Represents the request to get the header information of the CSV file for the user import job.",
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID for the user pool that the users are to be imported into."
        }
      ]
    }
  },
  "required": [
    "UserPoolId"
  ]
}