CreateRecipeJobRequest

CreateRecipeJobRequest schema from Amazon Glue DataBrew API

Data AnalyticsData PreparationETLMachine Learning

Properties

Name Type Description
DatasetName object
EncryptionKeyArn object
EncryptionMode object
Name object
LogSubscription object
MaxCapacity object
MaxRetries object
Outputs object
DataCatalogOutputs object
DatabaseOutputs object
ProjectName object
RecipeReference object
RoleArn object
Tags object
Timeout object
View JSON Schema on GitHub

JSON Schema

glue-databrew-create-recipe-job-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-glue-databrew/refs/heads/main/json-schema/glue-databrew-create-recipe-job-request-schema.json",
  "title": "CreateRecipeJobRequest",
  "description": "CreateRecipeJobRequest schema from Amazon Glue DataBrew API",
  "type": "object",
  "properties": {
    "DatasetName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DatasetName"
        },
        {
          "description": "The name of the dataset that this job processes."
        }
      ]
    },
    "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> - Server-side encryption with keys managed by KMS.</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": "A unique name for the job. 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 consume 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."
        }
      ]
    },
    "Outputs": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OutputList"
        },
        {
          "description": "One or more artifacts that represent the output from running the job."
        }
      ]
    },
    "DataCatalogOutputs": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DataCatalogOutputList"
        },
        {
          "description": "One or more artifacts that represent the Glue Data Catalog output from running the job."
        }
      ]
    },
    "DatabaseOutputs": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DatabaseOutputList"
        },
        {
          "description": "Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to. "
        }
      ]
    },
    "ProjectName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectName"
        },
        {
          "description": "Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe."
        }
      ]
    },
    "RecipeReference": {
      "$ref": "#/components/schemas/RecipeReference"
    },
    "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>."
        }
      ]
    }
  },
  "required": [
    "Name",
    "RoleArn"
  ]
}