Amazon Cognito · JSON Structure

Cognito Idp Get Csv Header Response Structure

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

Type: object Properties: 2
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

GetCSVHeaderResponse is a JSON Structure definition published by Amazon Cognito, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

UserPoolId CSVHeader

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "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."
        }
      ]
    },
    "CSVHeader": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfStringTypes"
        },
        {
          "description": "The header information of the CSV file for the user import job."
        }
      ]
    }
  },
  "description": "Represents the response from the server to the request to get the header information of the CSV file for the user import job.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-get-csv-header-response-structure.json",
  "name": "GetCSVHeaderResponse"
}