Amazon Cognito · Schema

CreateUserImportJobRequest

Represents the request to create the user import job.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
JobName object
UserPoolId object
CloudWatchLogsRoleArn object
View JSON Schema on GitHub

JSON Schema

user-pools-create-user-import-job-request-schema.json Raw ↑
{
  "$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-create-user-import-job-request-schema.json",
  "title": "CreateUserImportJobRequest",
  "description": "Represents the request to create the user import job.",
  "type": "object",
  "properties": {
    "JobName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserImportJobNameType"
        },
        {
          "description": "The job name for the user import job."
        }
      ]
    },
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID for the user pool that the users are being imported into."
        }
      ]
    },
    "CloudWatchLogsRoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArnType"
        },
        {
          "description": "The role ARN for the Amazon CloudWatch Logs Logging role for the user import job."
        }
      ]
    }
  },
  "required": [
    "JobName",
    "UserPoolId",
    "CloudWatchLogsRoleArn"
  ]
}