Skip to content

describe_ruleset

describe_ruleset(
    name: RulesetName, *, config_overrides: Optional[DataBrewClientConfig] = None
) -> DescribeRulesetResponse

Retrieves detailed information about the ruleset.

Parameters:

  • name (RulesetName) –

    The name of the ruleset to be described.

Raises:

Source code in docs_src/capo_databrew/_services/data_brew.py
def describe_ruleset(
    self,
    name: "capo_databrew.types.ruleset_name.RulesetName",
    *,
    config_overrides: Optional[DataBrewClientConfig] = None,
) -> "capo_databrew.types.describe_ruleset_response.DescribeRulesetResponse":
    """<p>Retrieves detailed information about the ruleset.</p>

    Args:
        name: <p>The name of the ruleset to be described.</p>

    Raises:
        capo_databrew.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_databrew.errors.validation_exception.ValidationException: <p>The input parameters for this request failed validation.</p>
        capo_databrew.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_databrew.types.describe_ruleset_request.DescribeRulesetRequest]",
    ) -> OperationResponse[
        "capo_databrew.types.describe_ruleset_response.DescribeRulesetResponse"
    ]:
        import capo_databrew._operations.aws_glue_data_brew.describe_ruleset

        output, http_response = (
            capo_databrew._operations.aws_glue_data_brew.describe_ruleset.describe_ruleset(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRuleset")
    )
    input_: capo_databrew.types.describe_ruleset_request.DescribeRulesetRequest = {
        "name": name
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output