Skip to content
AWS for Query.Farm

aws.databrew.describe_ruleset

Example SQL Queries

SELECT * FROM
aws.databrew.describe_ruleset
WHERE
"name" = 'VALUE';

Description

Retrieves detailed information about the ruleset.

Table Definition

Column NameColumn Data Type
name Required Input Column

The name of the ruleset.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
create_date

The date and time that the ruleset was created.

TIMESTAMP_S
created_by

The Amazon Resource Name (ARN) of the user who created the ruleset.

VARCHAR
description

The description of the ruleset.

VARCHAR
last_modified_by

The Amazon Resource Name (ARN) of the user who last modified the ruleset.

VARCHAR
last_modified_date

The modification date and time of the ruleset.

TIMESTAMP_S
resource_arn

The Amazon Resource Name (ARN) for the ruleset.

VARCHAR
rules

A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

STRUCT(
    "name" VARCHAR,
    "disabled" BOOLEAN,
    "check_expression" VARCHAR,
    "substitution_map" MAP(VARCHAR, VARCHAR),
    "threshold" STRUCT(
        "value" DOUBLE,
        "type" VARCHAR,
        "unit" VARCHAR
    ),
    "column_selectors" STRUCT(
        "regex" VARCHAR,
        "name" VARCHAR
    )[]
)[]
Show child fields
rules[]
Show child fields
rules[].check_expression

The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2). Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no column reference in the left side of a condition, for example, is_between :val1 and :val2.

For more information, see Available checks

rules[].column_selectors[]
Show child fields
rules[].column_selectors[].name

The name of a column from a dataset.

rules[].column_selectors[].regex

A regular expression for selecting a column from a dataset.

rules[].disabled

A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.

rules[].name

The name of the rule.

rules[].substitution_map

The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "`Column A`".

rules[].threshold

The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.

Show child fields
rules[].threshold.type

The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.

rules[].threshold.unit

Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.

rules[].threshold.value

The value of a threshold.

tags

Metadata tags that have been applied to the ruleset.

MAP(VARCHAR, VARCHAR)
target_arn

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

VARCHAR