Amazon Glue · JSON Structure

Glue Get Data Quality Rule Recommendation Run Response Structure

GetDataQualityRuleRecommendationRunResponse schema from Amazon Glue API

Type: object Properties: 13
AnalyticsData CatalogData IntegrationData PipelineETLServerless

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

Properties

RunId DataSource Role NumberOfWorkers Timeout Status ErrorString StartedOn LastModifiedOn CompletedOn ExecutionTime RecommendedRuleset CreatedRulesetName

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/refs/heads/main/json-structure/glue-get-data-quality-rule-recommendation-run-response-structure.json",
  "name": "GetDataQualityRuleRecommendationRunResponse",
  "description": "GetDataQualityRuleRecommendationRunResponse schema from Amazon Glue API",
  "type": "object",
  "properties": {
    "RunId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HashString"
        },
        {
          "description": "The unique run identifier associated with this run."
        }
      ]
    },
    "DataSource": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DataSource"
        },
        {
          "description": "The data source (an Glue table) associated with this run."
        }
      ]
    },
    "Role": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleString"
        },
        {
          "description": "An IAM role supplied to encrypt the results of the run."
        }
      ]
    },
    "NumberOfWorkers": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableInteger"
        },
        {
          "description": "The number of <code>G.1X</code> workers to be used in the run. The default is 5."
        }
      ]
    },
    "Timeout": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timeout"
        },
        {
          "description": "The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours)."
        }
      ]
    },
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TaskStatusType"
        },
        {
          "description": "The status for this run."
        }
      ]
    },
    "ErrorString": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenericString"
        },
        {
          "description": "The error strings that are associated with the run."
        }
      ]
    },
    "StartedOn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time when this run started."
        }
      ]
    },
    "LastModifiedOn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "A timestamp. The last point in time when this data quality rule recommendation run was modified."
        }
      ]
    },
    "CompletedOn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time when this run was completed."
        }
      ]
    },
    "ExecutionTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ExecutionTime"
        },
        {
          "description": "The amount of time (in seconds) that the run consumed resources."
        }
      ]
    },
    "RecommendedRuleset": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DataQualityRulesetString"
        },
        {
          "description": "When a start rule recommendation run completes, it creates a recommended ruleset (a set of rules). This member has those rules in Data Quality Definition Language (DQDL) format."
        }
      ]
    },
    "CreatedRulesetName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NameString"
        },
        {
          "description": "The name of the ruleset that was created by the run."
        }
      ]
    }
  }
}