Amazon Glue DataBrew · JSON Structure

Glue Databrew Create Profile Job Request Structure

CreateProfileJobRequest schema from Amazon Glue DataBrew API

Type: object Properties: 14 Required: 4
Data AnalyticsData PreparationETLMachine Learning

CreateProfileJobRequest is a JSON Structure definition published by Amazon Glue DataBrew, describing 14 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

DatasetName EncryptionKeyArn EncryptionMode Name LogSubscription MaxCapacity MaxRetries OutputLocation Configuration ValidationConfigurations RoleArn Tags Timeout JobSample

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-glue-databrew/refs/heads/main/json-structure/glue-databrew-create-profile-job-request-structure.json",
  "name": "CreateProfileJobRequest",
  "description": "CreateProfileJobRequest schema from Amazon Glue DataBrew API",
  "type": "object",
  "properties": {
    "DatasetName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DatasetName"
        },
        {
          "description": "The name of the dataset that this job is to act upon."
        }
      ]
    },
    "EncryptionKeyArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionKeyArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of an encryption key that is used to protect the job."
        }
      ]
    },
    "EncryptionMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionMode"
        },
        {
          "description": "<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - <code>SSE-KMS</code> - Server-side encryption with KMS-managed keys.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobName"
        },
        {
          "description": "The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space."
        }
      ]
    },
    "LogSubscription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LogSubscription"
        },
        {
          "description": "Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run."
        }
      ]
    },
    "MaxCapacity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaxCapacity"
        },
        {
          "description": "The maximum number of nodes that DataBrew can use when the job processes data."
        }
      ]
    },
    "MaxRetries": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaxRetries"
        },
        {
          "description": "The maximum number of times to retry the job after a job run fails."
        }
      ]
    },
    "OutputLocation": {
      "$ref": "#/components/schemas/S3Location"
    },
    "Configuration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProfileConfiguration"
        },
        {
          "description": "Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings."
        }
      ]
    },
    "ValidationConfigurations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ValidationConfigurationList"
        },
        {
          "description": "List of validation configurations that are applied to the profile job."
        }
      ]
    },
    "RoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job."
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "description": "Metadata tags to apply to this job."
        }
      ]
    },
    "Timeout": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timeout"
        },
        {
          "description": "The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>."
        }
      ]
    },
    "JobSample": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobSample"
        },
        {
          "description": "Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter."
        }
      ]
    }
  },
  "required": [
    "DatasetName",
    "Name",
    "OutputLocation",
    "RoleArn"
  ]
}