Amazon Cognito · JSON Structure

User Pools List User Import Jobs Request Structure

Represents the request to list the user import jobs.

Type: object Properties: 3 Required: 2
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

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

Properties

UserPoolId MaxResults PaginationToken

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-list-user-import-jobs-request-structure.json",
  "name": "ListUserImportJobsRequest",
  "description": "Represents the request to list the user import jobs.",
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID for the user pool that the users are being imported into."
        }
      ]
    },
    "MaxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PoolQueryLimitType"
        },
        {
          "description": "The maximum number of import jobs you want the request to return."
        }
      ]
    },
    "PaginationToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PaginationKeyType"
        },
        {
          "description": "An identifier that was returned from the previous call to <code>ListUserImportJobs</code>, which can be used to return the next set of import jobs in the list."
        }
      ]
    }
  },
  "required": [
    "UserPoolId",
    "MaxResults"
  ]
}