Amazon Glue DataBrew RecipeJobs API

openapi: 3.0.0
info:
  version: 2017-07-25
  x-release: v4
  title: AWS Glue DataBrew Datasets RecipeJobs API
  description: Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew simplifies data preparation tasks, targeting data issues that are hard to spot and time-consuming to fix. DataBrew empowers users of all technical levels to visualize the data and perform one-click data transformations, with no coding required.
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: databrew
  x-aws-signingName: databrew
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/databrew-2017-07-25.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://databrew.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Glue DataBrew multi-region endpoint
- url: https://databrew.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Glue DataBrew multi-region endpoint
- url: http://databrew.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Glue DataBrew endpoint for China (Beijing) and China (Ningxia)
- url: https://databrew.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Glue DataBrew endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: RecipeJobs
paths:
  /recipeJobs:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateRecipeJob
      description: Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRecipeJobResponse'
              examples:
                CreateRecipeJob200Example:
                  summary: Default CreateRecipeJob 200 response
                  x-microcks-default: true
                  value:
                    status: SUCCEEDED
        '480':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                CreateRecipeJob480Example:
                  summary: Default CreateRecipeJob 480 response
                  x-microcks-default: true
                  value:
                    status: SUCCEEDED
        '481':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                CreateRecipeJob481Example:
                  summary: Default CreateRecipeJob 481 response
                  x-microcks-default: true
                  value:
                    status: SUCCEEDED
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                CreateRecipeJob482Example:
                  summary: Default CreateRecipeJob 482 response
                  x-microcks-default: true
                  value:
                    status: SUCCEEDED
        '483':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
              examples:
                CreateRecipeJob483Example:
                  summary: Default CreateRecipeJob 483 response
                  x-microcks-default: true
                  value:
                    status: SUCCEEDED
        '484':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                CreateRecipeJob484Example:
                  summary: Default CreateRecipeJob 484 response
                  x-microcks-default: true
                  value:
                    status: SUCCEEDED
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - Name
              - RoleArn
              properties:
                DatasetName:
                  description: The name of the dataset that this job processes.
                  type: string
                  minLength: 1
                  maxLength: 255
                EncryptionKeyArn:
                  description: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
                  type: string
                  minLength: 20
                  maxLength: 2048
                EncryptionMode:
                  description: <p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with keys managed by KMS.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>
                  type: string
                  enum:
                  - SSE-KMS
                  - SSE-S3
                Name:
                  description: A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
                  type: string
                  minLength: 1
                  maxLength: 240
                LogSubscription:
                  description: Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
                  type: string
                  enum:
                  - ENABLE
                  - DISABLE
                MaxCapacity:
                  description: The maximum number of nodes that DataBrew can consume when the job processes data.
                  type: integer
                MaxRetries:
                  description: The maximum number of times to retry the job after a job run fails.
                  type: integer
                  minimum: 0
                Outputs:
                  description: One or more artifacts that represent the output from running the job.
                  type: array
                  items:
                    $ref: '#/components/schemas/Output'
                  minItems: 1
                DataCatalogOutputs:
                  description: One or more artifacts that represent the Glue Data Catalog output from running the job.
                  type: array
                  items:
                    $ref: '#/components/schemas/DataCatalogOutput'
                  minItems: 1
                DatabaseOutputs:
                  description: 'Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to. '
                  type: array
                  items:
                    $ref: '#/components/schemas/DatabaseOutput'
                  minItems: 1
                ProjectName:
                  description: Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.
                  type: string
                  minLength: 1
                  maxLength: 255
                RecipeReference:
                  description: Represents the name and version of a DataBrew recipe.
                  type: object
                  properties:
                    Name:
                      allOf:
                      - $ref: '#/components/schemas/RecipeName'
                      - description: The name of the recipe.
                    RecipeVersion:
                      allOf:
                      - $ref: '#/components/schemas/RecipeVersion'
                      - description: 'The identifier for the version for the recipe. '
                RoleArn:
                  description: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
                  type: string
                  minLength: 20
                  maxLength: 2048
                Tags:
                  description: Metadata tags to apply to this job.
                  type: object
                  minProperties: 1
                  maxProperties: 200
                  additionalProperties:
                    $ref: '#/components/schemas/TagValue'
                Timeout:
                  description: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.
                  type: integer
                  minimum: 0
      summary: Amazon Glue DataBrew Create Recipe Job
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - RecipeJobs
  /recipeJobs/{name}:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    put:
      operationId: UpdateRecipeJob
      description: Modifies the definition of an existing DataBrew recipe job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRecipeJobResponse'
              examples:
                UpdateRecipeJob200Example:
                  summary: Default UpdateRecipeJob 200 response
                  x-microcks-default: true
                  value:
                    status: SUCCEEDED
        '480':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                UpdateRecipeJob480Example:
                  summary: Default UpdateRecipeJob 480 response
                  x-microcks-default: true
                  value:
                    status: SUCCEEDED
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                UpdateRecipeJob481Example:
                  summary: Default UpdateRecipeJob 481 response
                  x-microcks-default: true
                  value:
                    status: SUCCEEDED
        '482':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                UpdateRecipeJob482Example:
                  summary: Default UpdateRecipeJob 482 response
                  x-microcks-default: true
                  value:
                    status: SUCCEEDED
      parameters:
      - name: name
        in: path
        required: true
        description: The name of the job to update.
        schema:
          type: string
          minLength: 1
          maxLength: 240
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - RoleArn
              properties:
                EncryptionKeyArn:
                  description: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
                  type: string
                  minLength: 20
                  maxLength: 2048
                EncryptionMode:
                  description: <p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with keys managed by KMS.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>
                  type: string
                  enum:
                  - SSE-KMS
                  - SSE-S3
                LogSubscription:
                  description: Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
                  type: string
                  enum:
                  - ENABLE
                  - DISABLE
                MaxCapacity:
                  description: The maximum number of nodes that DataBrew can consume when the job processes data.
                  type: integer
                MaxRetries:
                  description: The maximum number of times to retry the job after a job run fails.
                  type: integer
                  minimum: 0
                Outputs:
                  description: 'One or more artifacts that represent the output from running the job. '
                  type: array
                  items:
                    $ref: '#/components/schemas/Output'
                  minItems: 1
                DataCatalogOutputs:
                  description: One or more artifacts that represent the Glue Data Catalog output from running the job.
                  type: array
                  items:
                    $ref: '#/components/schemas/DataCatalogOutput'
                  minItems: 1
                DatabaseOutputs:
                  description: Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
                  type: array
                  items:
                    $ref: '#/components/schemas/DatabaseOutput'
                  minItems: 1
                RoleArn:
                  description: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
                  type: string
                  minLength: 20
                  maxLength: 2048
                Timeout:
                  description: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.
                  type: integer
                  minimum: 0
      summary: Amazon Glue DataBrew Update Recipe Job
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - RecipeJobs
components:
  schemas:
    RecipeName:
      type: string
      minLength: 1
      maxLength: 255
    OutputFormat:
      type: string
      enum:
      - CSV
      - JSON
      - PARQUET
      - GLUEPARQUET
      - AVRO
      - ORC
      - XML
      - TABLEAUHYPER
    OutputFormatOptions:
      type: object
      properties:
        Csv:
          allOf:
          - $ref: '#/components/schemas/CsvOutputOptions'
          - description: Represents a set of options that define the structure of comma-separated value (CSV) job output.
      description: Represents a set of options that define the structure of comma-separated (CSV) job output.
    DatabaseTableOutputOptions:
      type: object
      required:
      - TableName
      properties:
        TempDirectory:
          allOf:
          - $ref: '#/components/schemas/S3Location'
          - description: Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.
        TableName:
          allOf:
          - $ref: '#/components/schemas/DatabaseTableName'
          - description: A prefix for the name of a table DataBrew will create in the database.
      description: Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
    Delimiter:
      type: string
      minLength: 1
      maxLength: 1
    DatabaseTableName:
      type: string
      minLength: 1
      maxLength: 255
    TagValue:
      type: string
      maxLength: 256
    DataCatalogOutput:
      type: object
      required:
      - DatabaseName
      - TableName
      properties:
        CatalogId:
          allOf:
          - $ref: '#/components/schemas/CatalogId'
          - description: The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.
        DatabaseName:
          allOf:
          - $ref: '#/components/schemas/DatabaseName'
          - description: The name of a database in the Data Catalog.
        TableName:
          allOf:
          - $ref: '#/components/schemas/TableName'
          - description: The name of a table in the Data Catalog.
        S3Options:
          allOf:
          - $ref: '#/components/schemas/S3TableOutputOptions'
          - description: Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
        DatabaseOptions:
          allOf:
          - $ref: '#/components/schemas/DatabaseTableOutputOptions'
          - description: Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
        Overwrite:
          allOf:
          - $ref: '#/components/schemas/OverwriteOutput'
          - description: A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions.
      description: Represents options that specify how and where in the Glue Data Catalog DataBrew writes the output generated by recipe jobs.
    CsvOutputOptions:
      type: object
      properties:
        Delimiter:
          allOf:
          - $ref: '#/components/schemas/Delimiter'
          - description: A single character that specifies the delimiter used to create CSV job output.
      description: Represents a set of options that define how DataBrew will write a comma-separated value (CSV) file.
    BucketOwner:
      type: string
      pattern: ^[0-9]{12}$
      minLength: 12
      maxLength: 12
    RecipeVersion:
      type: string
      minLength: 1
      maxLength: 16
    ConflictException: {}
    CompressionFormat:
      type: string
      enum:
      - GZIP
      - LZ4
      - SNAPPY
      - BZIP2
      - DEFLATE
      - LZO
      - BROTLI
      - ZSTD
      - ZLIB
    S3Location:
      type: object
      required:
      - Bucket
      properties:
        Bucket:
          allOf:
          - $ref: '#/components/schemas/Bucket'
          - description: The Amazon S3 bucket name.
        Key:
          allOf:
          - $ref: '#/components/schemas/Key'
          - description: The unique name of the object in the bucket.
        BucketOwner:
          allOf:
          - $ref: '#/components/schemas/BucketOwner'
          - description: The Amazon Web Services account ID of the bucket owner.
      description: Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.
    Bucket:
      type: string
      minLength: 3
      maxLength: 63
    ServiceQuotaExceededException: {}
    ColumnNameList:
      type: array
      items:
        $ref: '#/components/schemas/ColumnName'
      maxItems: 200
    CreateRecipeJobResponse:
      type: object
      required:
      - Name
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/JobName'
          - description: The name of the job that you created.
    Key:
      type: string
      minLength: 1
      maxLength: 1280
    JobName:
      type: string
      minLength: 1
      maxLength: 240
    DatabaseOutputMode:
      type: string
      enum:
      - NEW_TABLE
    TableName:
      type: string
      minLength: 1
      maxLength: 255
    DatabaseOutput:
      type: object
      required:
      - GlueConnectionName
      - DatabaseOptions
      properties:
        GlueConnectionName:
          allOf:
          - $ref: '#/components/schemas/GlueConnectionName'
          - description: The Glue connection that stores the connection information for the target database.
        DatabaseOptions:
          allOf:
          - $ref: '#/components/schemas/DatabaseTableOutputOptions'
          - description: Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
        DatabaseOutputMode:
          allOf:
          - $ref: '#/components/schemas/DatabaseOutputMode'
          - description: 'The output mode to write into the database. Currently supported option: NEW_TABLE.'
      description: Represents a JDBC database output object which defines the output destination for a DataBrew recipe job to write into.
    ColumnName:
      type: string
      minLength: 1
      maxLength: 255
    ResourceNotFoundException: {}
    AccessDeniedException: {}
    Output:
      type: object
      required:
      - Location
      properties:
        CompressionFormat:
          allOf:
          - $ref: '#/components/schemas/CompressionFormat'
          - description: The compression algorithm used to compress the output text of the job.
        Format:
          allOf:
          - $ref: '#/components/schemas/OutputFormat'
          - description: The data format of the output of the job.
        PartitionColumns:
          allOf:
          - $ref: '#/components/schemas/ColumnNameList'
          - description: The names of one or more partition columns for the output of the job.
        Location:
          allOf:
          - $ref: '#/components/schemas/S3Location'
          - description: The location in Amazon S3 where the job writes its output.
        Overwrite:
          allOf:
          - $ref: '#/components/schemas/OverwriteOutput'
          - description: A value that, if true, means that any data in the location specified for output is overwritten with new output.
        FormatOptions:
          allOf:
          - $ref: '#/components/schemas/OutputFormatOptions'
          - description: Represents options that define how DataBrew formats job output files.
        MaxOutputFiles:
          allOf:
          - $ref: '#/components/schemas/MaxOutputFiles'
          - description: Maximum number of files to be generated by the job and written to the output folder. For output partitioned by column(s), the MaxOutputFiles value is the maximum number of files per partition.
      description: Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs.
    OverwriteOutput:
      type: boolean
    DatabaseName:
      type: string
      minLength: 1
      maxLength: 255
    ValidationException: {}
    UpdateRecipeJobResponse:
      type: object
      required:
      - Name
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/JobName'
          - description: The name of the job that you updated.
    GlueConnectionName:
      type: string
      minLength: 1
      maxLength: 255
    S3TableOutputOptions:
      type: object
      required:
      - Location
      properties:
        Location:
          allOf:
          - $ref: '#/components/schemas/S3Location'
          - description: Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.
      description: Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
    CatalogId:
      type: string
      minLength: 1
      maxLength: 255
    MaxOutputFiles:
      type: integer
      minimum: 1
      maximum: 999
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/databrew/
x-hasEquivalentPaths: true