awscc.databrew_job¶

Filters¶

  • event

  • reduce

  • value

Actions¶

delete¶

Parent base class for filters and actions.

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

Permissions - databrew:DeleteJob

update¶

Parent base class for filters and actions.

definitions:
  AllowedStatistics:
    additionalProperties: false
    properties:
      Statistics:
        insertionOrder: true
        items:
          maxLength: 128
          minLength: 1
          pattern: ^[A-Z\_]+$
          type: string
        minItems: 1
        type: array
    required:
    - Statistics
    type: object
  ColumnSelector:
    additionalProperties: false
    properties:
      Name:
        maxLength: 255
        minLength: 1
        type: string
      Regex:
        maxLength: 255
        minLength: 1
        type: string
    type: object
  ColumnStatisticsConfiguration:
    additionalProperties: false
    properties:
      Selectors:
        insertionOrder: true
        items:
          additionalProperties: false
          properties:
            Name:
              maxLength: 255
              minLength: 1
              type: string
            Regex:
              maxLength: 255
              minLength: 1
              type: string
          type: object
        minItems: 1
        type: array
      Statistics:
        additionalProperties: false
        properties:
          IncludedStatistics:
            insertionOrder: true
            items:
              maxLength: 128
              minLength: 1
              pattern: ^[A-Z\_]+$
              type: string
            minItems: 1
            type: array
          Overrides:
            insertionOrder: true
            items:
              additionalProperties: false
              properties:
                Parameters:
                  additionalProperties: false
                  patternProperties:
                    ^[A-Za-z0-9]{1,128}$:
                      type: string
                  type: object
                Statistic:
                  maxLength: 128
                  minLength: 1
                  pattern: ^[A-Z\_]+$
                  type: string
              required:
              - Statistic
              - Parameters
              type: object
            minItems: 1
            type: array
        type: object
    required:
    - Statistics
    type: object
  CsvOutputOptions:
    additionalProperties: false
    description: Output Csv options
    properties:
      Delimiter:
        maxLength: 1
        minLength: 1
        type: string
    type: object
  DataCatalogOutput:
    additionalProperties: false
    properties:
      CatalogId:
        maxLength: 255
        minLength: 1
        type: string
      DatabaseName:
        maxLength: 255
        minLength: 1
        type: string
      DatabaseOptions:
        additionalProperties: false
        properties:
          TableName:
            maxLength: 255
            minLength: 1
            type: string
          TempDirectory:
            additionalProperties: false
            description: S3 Output location
            properties:
              Bucket:
                type: string
              Key:
                type: string
            required:
            - Bucket
            type: object
        required:
        - TableName
        type: object
      Overwrite:
        type: boolean
      S3Options:
        additionalProperties: false
        properties:
          Location:
            additionalProperties: false
            description: S3 Output location
            properties:
              Bucket:
                type: string
              Key:
                type: string
            required:
            - Bucket
            type: object
        required:
        - Location
        type: object
      TableName:
        maxLength: 255
        minLength: 1
        type: string
    required:
    - DatabaseName
    - TableName
    type: object
  DatabaseOutput:
    additionalProperties: false
    properties:
      DatabaseOptions:
        additionalProperties: false
        properties:
          TableName:
            maxLength: 255
            minLength: 1
            type: string
          TempDirectory:
            additionalProperties: false
            description: S3 Output location
            properties:
              Bucket:
                type: string
              Key:
                type: string
            required:
            - Bucket
            type: object
        required:
        - TableName
        type: object
      DatabaseOutputMode:
        description: Database table name
        enum:
        - NEW_TABLE
        type: string
      GlueConnectionName:
        description: Glue connection name
        type: string
    required:
    - GlueConnectionName
    - DatabaseOptions
    type: object
  DatabaseTableOutputOptions:
    additionalProperties: false
    properties:
      TableName:
        maxLength: 255
        minLength: 1
        type: string
      TempDirectory:
        additionalProperties: false
        description: S3 Output location
        properties:
          Bucket:
            type: string
          Key:
            type: string
        required:
        - Bucket
        type: object
    required:
    - TableName
    type: object
  EntityDetectorConfiguration:
    additionalProperties: false
    properties:
      AllowedStatistics:
        additionalProperties: false
        properties:
          Statistics:
            insertionOrder: true
            items:
              maxLength: 128
              minLength: 1
              pattern: ^[A-Z\_]+$
              type: string
            minItems: 1
            type: array
        required:
        - Statistics
        type: object
      EntityTypes:
        insertionOrder: true
        items:
          maxLength: 128
          minLength: 1
          pattern: ^[A-Z_][A-Z\\d_]*$
          type: string
        minItems: 1
        type: array
    required:
    - EntityTypes
    type: object
  JobSample:
    additionalProperties: false
    description: Job Sample
    properties:
      Mode:
        description: Sample configuration mode for profile jobs.
        enum:
        - FULL_DATASET
        - CUSTOM_ROWS
        type: string
      Size:
        description: Sample configuration size for profile jobs.
        format: int64
        type: integer
    type: object
  JobSize:
    description: Sample configuration size for profile jobs.
    format: int64
    type: integer
  Output:
    additionalProperties: false
    properties:
      CompressionFormat:
        enum:
        - GZIP
        - LZ4
        - SNAPPY
        - BZIP2
        - DEFLATE
        - LZO
        - BROTLI
        - ZSTD
        - ZLIB
        type: string
      Format:
        enum:
        - CSV
        - JSON
        - PARQUET
        - GLUEPARQUET
        - AVRO
        - ORC
        - XML
        - TABLEAUHYPER
        type: string
      FormatOptions:
        additionalProperties: false
        description: Format options for job Output
        properties:
          Csv:
            additionalProperties: false
            description: Output Csv options
            properties:
              Delimiter:
                maxLength: 1
                minLength: 1
                type: string
            type: object
        type: object
      Location:
        additionalProperties: false
        description: S3 Output location
        properties:
          Bucket:
            type: string
          Key:
            type: string
        required:
        - Bucket
        type: object
      Overwrite:
        type: boolean
      PartitionColumns:
        insertionOrder: true
        items:
          type: string
        type: array
        uniqueItems: true
    required:
    - Location
    type: object
  OutputFormatOptions:
    additionalProperties: false
    description: Format options for job Output
    properties:
      Csv:
        additionalProperties: false
        description: Output Csv options
        properties:
          Delimiter:
            maxLength: 1
            minLength: 1
            type: string
        type: object
    type: object
  OutputLocation:
    additionalProperties: false
    description: Output location
    properties:
      Bucket:
        type: string
      Key:
        type: string
    required:
    - Bucket
    type: object
  ParameterMap:
    additionalProperties: false
    patternProperties:
      ^[A-Za-z0-9]{1,128}$:
        type: string
    type: object
  ProfileConfiguration:
    additionalProperties: false
    properties:
      ColumnStatisticsConfigurations:
        insertionOrder: true
        items:
          additionalProperties: false
          properties:
            Selectors:
              insertionOrder: true
              items:
                additionalProperties: false
                properties:
                  Name:
                    maxLength: 255
                    minLength: 1
                    type: string
                  Regex:
                    maxLength: 255
                    minLength: 1
                    type: string
                type: object
              minItems: 1
              type: array
            Statistics:
              additionalProperties: false
              properties:
                IncludedStatistics:
                  insertionOrder: true
                  items:
                    maxLength: 128
                    minLength: 1
                    pattern: ^[A-Z\_]+$
                    type: string
                  minItems: 1
                  type: array
                Overrides:
                  insertionOrder: true
                  items:
                    additionalProperties: false
                    properties:
                      Parameters:
                        additionalProperties: false
                        patternProperties:
                          ^[A-Za-z0-9]{1,128}$:
                            type: string
                        type: object
                      Statistic:
                        maxLength: 128
                        minLength: 1
                        pattern: ^[A-Z\_]+$
                        type: string
                    required:
                    - Statistic
                    - Parameters
                    type: object
                  minItems: 1
                  type: array
              type: object
          required:
          - Statistics
          type: object
        minItems: 1
        type: array
      DatasetStatisticsConfiguration:
        additionalProperties: false
        properties:
          IncludedStatistics:
            insertionOrder: true
            items:
              maxLength: 128
              minLength: 1
              pattern: ^[A-Z\_]+$
              type: string
            minItems: 1
            type: array
          Overrides:
            insertionOrder: true
            items:
              additionalProperties: false
              properties:
                Parameters:
                  additionalProperties: false
                  patternProperties:
                    ^[A-Za-z0-9]{1,128}$:
                      type: string
                  type: object
                Statistic:
                  maxLength: 128
                  minLength: 1
                  pattern: ^[A-Z\_]+$
                  type: string
              required:
              - Statistic
              - Parameters
              type: object
            minItems: 1
            type: array
        type: object
      EntityDetectorConfiguration:
        additionalProperties: false
        properties:
          AllowedStatistics:
            additionalProperties: false
            properties:
              Statistics:
                insertionOrder: true
                items:
                  maxLength: 128
                  minLength: 1
                  pattern: ^[A-Z\_]+$
                  type: string
                minItems: 1
                type: array
            required:
            - Statistics
            type: object
          EntityTypes:
            insertionOrder: true
            items:
              maxLength: 128
              minLength: 1
              pattern: ^[A-Z_][A-Z\\d_]*$
              type: string
            minItems: 1
            type: array
        required:
        - EntityTypes
        type: object
      ProfileColumns:
        insertionOrder: true
        items:
          additionalProperties: false
          properties:
            Name:
              maxLength: 255
              minLength: 1
              type: string
            Regex:
              maxLength: 255
              minLength: 1
              type: string
          type: object
        minItems: 1
        type: array
    type: object
  Recipe:
    additionalProperties: false
    properties:
      Name:
        description: Recipe name
        type: string
      Version:
        description: Recipe version
        type: string
    required:
    - Name
    type: object
  S3Location:
    additionalProperties: false
    description: S3 Output location
    properties:
      Bucket:
        type: string
      Key:
        type: string
    required:
    - Bucket
    type: object
  S3TableOutputOptions:
    additionalProperties: false
    properties:
      Location:
        additionalProperties: false
        description: S3 Output location
        properties:
          Bucket:
            type: string
          Key:
            type: string
        required:
        - Bucket
        type: object
    required:
    - Location
    type: object
  SampleMode:
    description: Sample configuration mode for profile jobs.
    enum:
    - FULL_DATASET
    - CUSTOM_ROWS
    type: string
  Statistic:
    maxLength: 128
    minLength: 1
    pattern: ^[A-Z\_]+$
    type: string
  StatisticOverride:
    additionalProperties: false
    properties:
      Parameters:
        additionalProperties: false
        patternProperties:
          ^[A-Za-z0-9]{1,128}$:
            type: string
        type: object
      Statistic:
        maxLength: 128
        minLength: 1
        pattern: ^[A-Z\_]+$
        type: string
    required:
    - Statistic
    - Parameters
    type: object
  StatisticsConfiguration:
    additionalProperties: false
    properties:
      IncludedStatistics:
        insertionOrder: true
        items:
          maxLength: 128
          minLength: 1
          pattern: ^[A-Z\_]+$
          type: string
        minItems: 1
        type: array
      Overrides:
        insertionOrder: true
        items:
          additionalProperties: false
          properties:
            Parameters:
              additionalProperties: false
              patternProperties:
                ^[A-Za-z0-9]{1,128}$:
                  type: string
              type: object
            Statistic:
              maxLength: 128
              minLength: 1
              pattern: ^[A-Z\_]+$
              type: string
          required:
          - Statistic
          - Parameters
          type: object
        minItems: 1
        type: array
    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
  ValidationConfiguration:
    additionalProperties: false
    description: Configuration to attach Rulesets to the job
    properties:
      RulesetArn:
        description: Arn of the Ruleset
        maxLength: 2048
        minLength: 20
        type: string
      ValidationMode:
        enum:
        - CHECK_ALL
        type: string
    required:
    - RulesetArn
    type: object
  ValidationMode:
    enum:
    - CHECK_ALL
    type: string
properties:
  DataCatalogOutputs:
    insertionOrder: true
    items:
      additionalProperties: false
      properties:
        CatalogId:
          maxLength: 255
          minLength: 1
          type: string
        DatabaseName:
          maxLength: 255
          minLength: 1
          type: string
        DatabaseOptions:
          additionalProperties: false
          properties:
            TableName:
              maxLength: 255
              minLength: 1
              type: string
            TempDirectory:
              additionalProperties: false
              description: S3 Output location
              properties:
                Bucket:
                  type: string
                Key:
                  type: string
              required:
              - Bucket
              type: object
          required:
          - TableName
          type: object
        Overwrite:
          type: boolean
        S3Options:
          additionalProperties: false
          properties:
            Location:
              additionalProperties: false
              description: S3 Output location
              properties:
                Bucket:
                  type: string
                Key:
                  type: string
              required:
              - Bucket
              type: object
          required:
          - Location
          type: object
        TableName:
          maxLength: 255
          minLength: 1
          type: string
      required:
      - DatabaseName
      - TableName
      type: object
    type: array
  DatabaseOutputs:
    insertionOrder: true
    items:
      additionalProperties: false
      properties:
        DatabaseOptions:
          additionalProperties: false
          properties:
            TableName:
              maxLength: 255
              minLength: 1
              type: string
            TempDirectory:
              additionalProperties: false
              description: S3 Output location
              properties:
                Bucket:
                  type: string
                Key:
                  type: string
              required:
              - Bucket
              type: object
          required:
          - TableName
          type: object
        DatabaseOutputMode:
          description: Database table name
          enum:
          - NEW_TABLE
          type: string
        GlueConnectionName:
          description: Glue connection name
          type: string
      required:
      - GlueConnectionName
      - DatabaseOptions
      type: object
    type: array
  DatasetName:
    description: Dataset name
    maxLength: 255
    minLength: 1
    type: string
  EncryptionKeyArn:
    description: Encryption Key Arn
    maxLength: 2048
    minLength: 20
    type: string
  EncryptionMode:
    description: Encryption mode
    enum:
    - SSE-KMS
    - SSE-S3
    type: string
  JobSample:
    additionalProperties: false
    description: Job Sample
    properties:
      Mode:
        description: Sample configuration mode for profile jobs.
        enum:
        - FULL_DATASET
        - CUSTOM_ROWS
        type: string
      Size:
        description: Sample configuration size for profile jobs.
        format: int64
        type: integer
    type: object
  LogSubscription:
    description: Log subscription
    enum:
    - ENABLE
    - DISABLE
    type: string
  MaxCapacity:
    description: Max capacity
    type: integer
  MaxRetries:
    description: Max retries
    type: integer
  OutputLocation:
    additionalProperties: false
    description: Output location
    properties:
      Bucket:
        type: string
      Key:
        type: string
    required:
    - Bucket
    type: object
  Outputs:
    insertionOrder: true
    items:
      additionalProperties: false
      properties:
        CompressionFormat:
          enum:
          - GZIP
          - LZ4
          - SNAPPY
          - BZIP2
          - DEFLATE
          - LZO
          - BROTLI
          - ZSTD
          - ZLIB
          type: string
        Format:
          enum:
          - CSV
          - JSON
          - PARQUET
          - GLUEPARQUET
          - AVRO
          - ORC
          - XML
          - TABLEAUHYPER
          type: string
        FormatOptions:
          additionalProperties: false
          description: Format options for job Output
          properties:
            Csv:
              additionalProperties: false
              description: Output Csv options
              properties:
                Delimiter:
                  maxLength: 1
                  minLength: 1
                  type: string
              type: object
          type: object
        Location:
          additionalProperties: false
          description: S3 Output location
          properties:
            Bucket:
              type: string
            Key:
              type: string
          required:
          - Bucket
          type: object
        Overwrite:
          type: boolean
        PartitionColumns:
          insertionOrder: true
          items:
            type: string
          type: array
          uniqueItems: true
      required:
      - Location
      type: object
    type: array
  ProfileConfiguration:
    additionalProperties: false
    properties:
      ColumnStatisticsConfigurations:
        insertionOrder: true
        items:
          additionalProperties: false
          properties:
            Selectors:
              insertionOrder: true
              items:
                additionalProperties: false
                properties:
                  Name:
                    maxLength: 255
                    minLength: 1
                    type: string
                  Regex:
                    maxLength: 255
                    minLength: 1
                    type: string
                type: object
              minItems: 1
              type: array
            Statistics:
              additionalProperties: false
              properties:
                IncludedStatistics:
                  insertionOrder: true
                  items:
                    maxLength: 128
                    minLength: 1
                    pattern: ^[A-Z\_]+$
                    type: string
                  minItems: 1
                  type: array
                Overrides:
                  insertionOrder: true
                  items:
                    additionalProperties: false
                    properties:
                      Parameters:
                        additionalProperties: false
                        patternProperties:
                          ^[A-Za-z0-9]{1,128}$:
                            type: string
                        type: object
                      Statistic:
                        maxLength: 128
                        minLength: 1
                        pattern: ^[A-Z\_]+$
                        type: string
                    required:
                    - Statistic
                    - Parameters
                    type: object
                  minItems: 1
                  type: array
              type: object
          required:
          - Statistics
          type: object
        minItems: 1
        type: array
      DatasetStatisticsConfiguration:
        additionalProperties: false
        properties:
          IncludedStatistics:
            insertionOrder: true
            items:
              maxLength: 128
              minLength: 1
              pattern: ^[A-Z\_]+$
              type: string
            minItems: 1
            type: array
          Overrides:
            insertionOrder: true
            items:
              additionalProperties: false
              properties:
                Parameters:
                  additionalProperties: false
                  patternProperties:
                    ^[A-Za-z0-9]{1,128}$:
                      type: string
                  type: object
                Statistic:
                  maxLength: 128
                  minLength: 1
                  pattern: ^[A-Z\_]+$
                  type: string
              required:
              - Statistic
              - Parameters
              type: object
            minItems: 1
            type: array
        type: object
      EntityDetectorConfiguration:
        additionalProperties: false
        properties:
          AllowedStatistics:
            additionalProperties: false
            properties:
              Statistics:
                insertionOrder: true
                items:
                  maxLength: 128
                  minLength: 1
                  pattern: ^[A-Z\_]+$
                  type: string
                minItems: 1
                type: array
            required:
            - Statistics
            type: object
          EntityTypes:
            insertionOrder: true
            items:
              maxLength: 128
              minLength: 1
              pattern: ^[A-Z_][A-Z\\d_]*$
              type: string
            minItems: 1
            type: array
        required:
        - EntityTypes
        type: object
      ProfileColumns:
        insertionOrder: true
        items:
          additionalProperties: false
          properties:
            Name:
              maxLength: 255
              minLength: 1
              type: string
            Regex:
              maxLength: 255
              minLength: 1
              type: string
          type: object
        minItems: 1
        type: array
    type: object
  ProjectName:
    description: Project name
    maxLength: 255
    minLength: 1
    type: string
  Recipe:
    additionalProperties: false
    properties:
      Name:
        description: Recipe name
        type: string
      Version:
        description: Recipe version
        type: string
    required:
    - Name
    type: object
  RoleArn:
    description: Role arn
    type: string
  Timeout:
    description: Timeout
    type: integer
  ValidationConfigurations:
    description: Data quality rules configuration
    insertionOrder: true
    items:
      additionalProperties: false
      description: Configuration to attach Rulesets to the job
      properties:
        RulesetArn:
          description: Arn of the Ruleset
          maxLength: 2048
          minLength: 20
          type: string
        ValidationMode:
          enum:
          - CHECK_ALL
          type: string
      required:
      - RulesetArn
      type: object
    minItems: 1
    type: array
  type:
    enum:
    - update

Permissions - databrew:UpdateProfileJob, databrew:UpdateRecipeJob