GetDataQualityRulesetCommand

Suggest an Edit

Returns an existing ruleset by identifier or name.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { GlueClient, GetDataQualityRulesetCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, GetDataQualityRulesetCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // GetDataQualityRulesetRequest
  Name: "STRING_VALUE", // required
};
const command = new GetDataQualityRulesetCommand(input);
const response = await client.send(command);
// { // GetDataQualityRulesetResponse
//   Name: "STRING_VALUE",
//   Description: "STRING_VALUE",
//   Ruleset: "STRING_VALUE",
//   TargetTable: { // DataQualityTargetTable
//     TableName: "STRING_VALUE", // required
//     DatabaseName: "STRING_VALUE", // required
//     CatalogId: "STRING_VALUE",
//   },
//   CreatedOn: new Date("TIMESTAMP"),
//   LastModifiedOn: new Date("TIMESTAMP"),
//   RecommendationRunId: "STRING_VALUE",
//   DataQualitySecurityConfiguration: "STRING_VALUE",
// };

GetDataQualityRulesetCommand Input

See GetDataQualityRulesetCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

The name of the ruleset.

GetDataQualityRulesetCommand Output

See GetDataQualityRulesetCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CreatedOn
Date | undefined

A timestamp. The time and date that this data quality ruleset was created.

DataQualitySecurityConfiguration
string | undefined

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

Description
string | undefined

A description of the ruleset.

LastModifiedOn
Date | undefined

A timestamp. The last point in time when this data quality ruleset was modified.

Name
string | undefined

The name of the ruleset.

RecommendationRunId
string | undefined

When a ruleset was created from a recommendation run, this run ID is generated to link the two together.

Ruleset
string | undefined

A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.

TargetTable
DataQualityTargetTable | undefined

The name and database name of the target table.

Throws

Name
Fault
Details
EntityNotFoundException
client

A specified entity does not exist

InternalServiceException
server

An internal service error occurred.

InvalidInputException
client

The input provided was not valid.

OperationTimeoutException
client

The operation timed out.

GlueServiceException
Base exception class for all service exceptions from Glue service.