Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetDataQualityRuleRecommendationRun

Gets the specified recommendation run that was used to generate rules.

Request Syntax


{
   "RunId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

RunId

The unique run identifier associated with this run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Response Syntax


{
   "CompletedOn": number,
   "CreatedRulesetName": "string",
   "DataQualitySecurityConfiguration": "string",
   "DataSource": { 
      "GlueTable": { 
         "AdditionalOptions": { 
            "string" : "string" 
         },
         "CatalogId": "string",
         "ConnectionName": "string",
         "DatabaseName": "string",
         "TableName": "string"
      }
   },
   "ErrorString": "string",
   "ExecutionTime": number,
   "LastModifiedOn": number,
   "NumberOfWorkers": number,
   "RecommendedRuleset": "string",
   "Role": "string",
   "RunId": "string",
   "StartedOn": number,
   "Status": "string",
   "Timeout": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CompletedOn

The date and time when this run was completed.

Type: Timestamp

CreatedRulesetName

The name of the ruleset that was created by the run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

DataQualitySecurityConfiguration

The name of the security configuration created with the data quality encryption option.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

DataSource

The data source (an AWS Glue table) associated with this run.

Type: DataSource object

ErrorString

The error strings that are associated with the run.

Type: String

ExecutionTime

The amount of time (in seconds) that the run consumed resources.

Type: Integer

LastModifiedOn

A timestamp. The last point in time when this data quality rule recommendation run was modified.

Type: Timestamp

NumberOfWorkers

The number of G.1X workers to be used in the run. The default is 5.

Type: Integer

RecommendedRuleset

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 65536.

Role

An IAM role supplied to encrypt the results of the run.

Type: String

RunId

The unique run identifier associated with this run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

StartedOn

The date and time when this run started.

Type: Timestamp

Status

The status for this run.

Type: String

Timeout

The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

Type: Integer

Valid Range: Minimum value of 1.

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400