awscc.databrew_ruleset

Filters

• event

• reduce

• value

Actions

• delete

• update

• webhook

delete

Parent base class for filters and actions.

properties:
  type:
    enum:
    - delete
required:
- type

Permissions - databrew:DeleteRuleset

update

Parent base class for filters and actions.

definitions:
  ColumnSelector:
    additionalProperties: false
    description: Selector of a column from a dataset for profile job configuration.
      One selector includes either a column name or a regular expression
    properties:
      Name:
        description: The name of a column from a dataset
        maxLength: 255
        minLength: 1
        type: string
      Regex:
        description: A regular expression for selecting a column from a dataset
        maxLength: 255
        minLength: 1
        type: string
    type: object
  Disabled:
    description: Boolean value to disable/enable a rule
    type: boolean
  Expression:
    description: Expression with rule conditions
    maxLength: 1024
    minLength: 4
    pattern: ^[><0-9A-Za-z_.,:)(!= ]+$
    type: string
  Rule:
    additionalProperties: false
    description: Data quality rule for a target resource (dataset)
    properties:
      CheckExpression:
        description: Expression with rule conditions
        maxLength: 1024
        minLength: 4
        pattern: ^[><0-9A-Za-z_.,:)(!= ]+$
        type: string
      ColumnSelectors:
        insertionOrder: true
        items:
          additionalProperties: false
          description: Selector of a column from a dataset for profile job configuration.
            One selector includes either a column name or a regular expression
          properties:
            Name:
              description: The name of a column from a dataset
              maxLength: 255
              minLength: 1
              type: string
            Regex:
              description: A regular expression for selecting a column from a dataset
              maxLength: 255
              minLength: 1
              type: string
          type: object
        minItems: 1
        type: array
      Disabled:
        description: Boolean value to disable/enable a rule
        type: boolean
      Name:
        description: Name of the rule
        maxLength: 128
        minLength: 1
        type: string
      SubstitutionMap:
        insertionOrder: true
        items:
          additionalProperties: false
          description: A key-value pair to associate expression's substitution variable
            names with their values
          properties:
            Value:
              description: Value or column name
              maxLength: 1024
              minLength: 0
              type: string
            ValueReference:
              description: Variable name
              maxLength: 128
              minLength: 2
              pattern: ^:[A-Za-z0-9_]+$
              type: string
          required:
          - ValueReference
          - Value
          type: object
        type: array
      Threshold:
        additionalProperties: false
        properties:
          Type:
            description: Threshold type for a rule
            enum:
            - GREATER_THAN_OR_EQUAL
            - LESS_THAN_OR_EQUAL
            - GREATER_THAN
            - LESS_THAN
            type: string
          Unit:
            description: Threshold unit for a rule
            enum:
            - COUNT
            - PERCENTAGE
            type: string
          Value:
            description: Threshold value for a rule
            type: number
        required:
        - Value
        type: object
    required:
    - Name
    - CheckExpression
    type: object
  SubstitutionValue:
    additionalProperties: false
    description: A key-value pair to associate expression's substitution variable
      names with their values
    properties:
      Value:
        description: Value or column name
        maxLength: 1024
        minLength: 0
        type: string
      ValueReference:
        description: Variable name
        maxLength: 128
        minLength: 2
        pattern: ^:[A-Za-z0-9_]+$
        type: string
    required:
    - ValueReference
    - Value
    type: object
  Tag:
    additionalProperties: false
    description: A key-value pair to associate with a resource
    properties:
      Key:
        maxLength: 128
        minLength: 1
        type: string
      Value:
        maxLength: 256
        minLength: 0
        type: string
    required:
    - Value
    - Key
    type: object
  Threshold:
    additionalProperties: false
    properties:
      Type:
        description: Threshold type for a rule
        enum:
        - GREATER_THAN_OR_EQUAL
        - LESS_THAN_OR_EQUAL
        - GREATER_THAN
        - LESS_THAN
        type: string
      Unit:
        description: Threshold unit for a rule
        enum:
        - COUNT
        - PERCENTAGE
        type: string
      Value:
        description: Threshold value for a rule
        type: number
    required:
    - Value
    type: object
  ThresholdType:
    description: Threshold type for a rule
    enum:
    - GREATER_THAN_OR_EQUAL
    - LESS_THAN_OR_EQUAL
    - GREATER_THAN
    - LESS_THAN
    type: string
  ThresholdUnit:
    description: Threshold unit for a rule
    enum:
    - COUNT
    - PERCENTAGE
    type: string
  ThresholdValue:
    description: Threshold value for a rule
    type: number
  ValuesMap:
    insertionOrder: true
    items:
      additionalProperties: false
      description: A key-value pair to associate expression's substitution variable
        names with their values
      properties:
        Value:
          description: Value or column name
          maxLength: 1024
          minLength: 0
          type: string
        ValueReference:
          description: Variable name
          maxLength: 128
          minLength: 2
          pattern: ^:[A-Za-z0-9_]+$
          type: string
      required:
      - ValueReference
      - Value
      type: object
    type: array
properties:
  Description:
    description: Description of the Ruleset
    maxLength: 1024
    type: string
  Rules:
    description: List of the data quality rules in the ruleset
    insertionOrder: true
    items:
      additionalProperties: false
      description: Data quality rule for a target resource (dataset)
      properties:
        CheckExpression:
          description: Expression with rule conditions
          maxLength: 1024
          minLength: 4
          pattern: ^[><0-9A-Za-z_.,:)(!= ]+$
          type: string
        ColumnSelectors:
          insertionOrder: true
          items:
            additionalProperties: false
            description: Selector of a column from a dataset for profile job configuration.
              One selector includes either a column name or a regular expression
            properties:
              Name:
                description: The name of a column from a dataset
                maxLength: 255
                minLength: 1
                type: string
              Regex:
                description: A regular expression for selecting a column from a dataset
                maxLength: 255
                minLength: 1
                type: string
            type: object
          minItems: 1
          type: array
        Disabled:
          description: Boolean value to disable/enable a rule
          type: boolean
        Name:
          description: Name of the rule
          maxLength: 128
          minLength: 1
          type: string
        SubstitutionMap:
          insertionOrder: true
          items:
            additionalProperties: false
            description: A key-value pair to associate expression's substitution variable
              names with their values
            properties:
              Value:
                description: Value or column name
                maxLength: 1024
                minLength: 0
                type: string
              ValueReference:
                description: Variable name
                maxLength: 128
                minLength: 2
                pattern: ^:[A-Za-z0-9_]+$
                type: string
            required:
            - ValueReference
            - Value
            type: object
          type: array
        Threshold:
          additionalProperties: false
          properties:
            Type:
              description: Threshold type for a rule
              enum:
              - GREATER_THAN_OR_EQUAL
              - LESS_THAN_OR_EQUAL
              - GREATER_THAN
              - LESS_THAN
              type: string
            Unit:
              description: Threshold unit for a rule
              enum:
              - COUNT
              - PERCENTAGE
              type: string
            Value:
              description: Threshold value for a rule
              type: number
          required:
          - Value
          type: object
      required:
      - Name
      - CheckExpression
      type: object
    minItems: 1
    type: array
  Tags:
    insertionOrder: false
    items:
      additionalProperties: false
      description: A key-value pair to associate with a resource
      properties:
        Key:
          maxLength: 128
          minLength: 1
          type: string
        Value:
          maxLength: 256
          minLength: 0
          type: string
      required:
      - Value
      - Key
      type: object
    type: array
    uniqueItems: false
  type:
    enum:
    - update

Permissions - databrew:UpdateRuleset