Glue / Client / get_data_quality_ruleset

get_data_quality_ruleset#

Glue.Client.get_data_quality_ruleset(**kwargs)#

Returns an existing ruleset by identifier or name.

Request Syntax

response = client.get_data_quality_ruleset(
    Name='string'
)

Parameters:

Name (string) –

[REQUIRED]

The name of the ruleset.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'Description': 'string',
    'Ruleset': 'string',
    'TargetTable': {
        'TableName': 'string',
        'DatabaseName': 'string',
        'CatalogId': 'string'
    },
    'CreatedOn': datetime(2015, 1, 1),
    'LastModifiedOn': datetime(2015, 1, 1),
    'RecommendationRunId': 'string'
}

Response Structure

(dict) –
- Name (string) –
  
  The name of the ruleset.
- Description (string) –
  
  A description of the ruleset.
- Ruleset (string) –
  
  A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
- TargetTable (dict) –
  
  The name and database name of the target table.
  - TableName (string) –
    
    The name of the Glue table.
  - DatabaseName (string) –
    
    The name of the database where the Glue table exists.
  - CatalogId (string) –
    
    The catalog id where the Glue table exists.
- CreatedOn (datetime) –
  
  A timestamp. The time and date that this data quality ruleset was created.
- LastModifiedOn (datetime) –
  
  A timestamp. The last point in time when this data quality ruleset was modified.
- RecommendationRunId (string) –
  
  When a ruleset was created from a recommendation run, this run ID is generated to link the two together.

Exceptions

Glue.Client.exceptions.EntityNotFoundException
Glue.Client.exceptions.InvalidInputException
Glue.Client.exceptions.OperationTimeoutException
Glue.Client.exceptions.InternalServiceException