Amazon Glue DataBrew Recipe Versions API

openapi: 3.2.0
info:
  version: 2017-07-25
  x-release: v4
  title: AWS Glue DataBrew Recipe Versions 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: RecipeVersions
paths:
  /recipeVersions#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'
    get:
      operationId: ListRecipeVersions
      description: Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRecipeVersionsResponse'
              examples:
                ListRecipeVersions200Example:
                  summary: Default ListRecipeVersions 200 response
                  x-microcks-default: true
                  value:
                    status: SUCCEEDED
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                ListRecipeVersions480Example:
                  summary: Default ListRecipeVersions 480 response
                  x-microcks-default: true
                  value:
                    status: SUCCEEDED
      parameters:
      - name: maxResults
        in: query
        required: false
        description: 'The maximum number of results to return in this request. '
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: nextToken
        in: query
        required: false
        description: The token returned by a previous call to retrieve the next set of results.
        schema:
          type: string
          minLength: 1
          maxLength: 2000
      - name: name
        in: query
        required: true
        description: The name of the recipe for which to return version information.
        schema:
          type: string
          minLength: 1
          maxLength: 255
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      summary: Amazon Glue DataBrew List Recipe Versions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - RecipeVersions
components:
  schemas:
    ParameterValue:
      type: string
      minLength: 1
      maxLength: 32768
    RecipeName:
      type: string
      minLength: 1
      maxLength: 255
    Date:
      type: string
      format: date-time
    RecipeDescription:
      type: string
      maxLength: 1024
    TagMap:
      type: object
      minProperties: 1
      maxProperties: 200
      additionalProperties:
        $ref: '#/components/schemas/TagValue'
    ParameterMap:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/ParameterValue'
    Arn:
      type: string
      minLength: 20
      maxLength: 2048
    LastModifiedBy:
      type: string
    RecipeStepList:
      type: array
      items:
        $ref: '#/components/schemas/RecipeStep'
    TagValue:
      type: string
      maxLength: 256
    NextToken:
      type: string
      minLength: 1
      maxLength: 2000
    CreatedBy:
      type: string
    RecipeStep:
      type: object
      required:
      - Action
      properties:
        Action:
          allOf:
          - $ref: '#/components/schemas/RecipeAction'
          - description: The particular action to be performed in the recipe step.
        ConditionExpressions:
          allOf:
          - $ref: '#/components/schemas/ConditionExpressionList'
          - description: <p>One or more conditions that must be met for the recipe step to succeed.</p> <note> <p>All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation.</p> </note>
      description: Represents a single step from a DataBrew recipe to be performed.
    RecipeAction:
      type: object
      required:
      - Operation
      properties:
        Operation:
          allOf:
          - $ref: '#/components/schemas/Operation'
          - description: The name of a valid DataBrew transformation to be performed on the data.
        Parameters:
          allOf:
          - $ref: '#/components/schemas/ParameterMap'
          - description: Contextual parameters for the transformation.
      description: Represents a transformation and associated parameters that are used to apply a change to a DataBrew dataset. For more information, see <a href="https://docs.aws.amazon.com/databrew/latest/dg/recipe-actions-reference.html">Recipe actions reference</a>.
    ProjectName:
      type: string
      minLength: 1
      maxLength: 255
    Recipe:
      type: object
      required:
      - Name
      properties:
        CreatedBy:
          allOf:
          - $ref: '#/components/schemas/CreatedBy'
          - description: The Amazon Resource Name (ARN) of the user who created the recipe.
        CreateDate:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The date and time that the recipe was created.
        LastModifiedBy:
          allOf:
          - $ref: '#/components/schemas/LastModifiedBy'
          - description: The Amazon Resource Name (ARN) of the user who last modified the recipe.
        LastModifiedDate:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The last modification date and time of the recipe.
        ProjectName:
          allOf:
          - $ref: '#/components/schemas/ProjectName'
          - description: The name of the project that the recipe is associated with.
        PublishedBy:
          allOf:
          - $ref: '#/components/schemas/PublishedBy'
          - description: The Amazon Resource Name (ARN) of the user who published the recipe.
        PublishedDate:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The date and time when the recipe was published.
        Description:
          allOf:
          - $ref: '#/components/schemas/RecipeDescription'
          - description: The description of the recipe.
        Name:
          allOf:
          - $ref: '#/components/schemas/RecipeName'
          - description: The unique name for the recipe.
        ResourceArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The Amazon Resource Name (ARN) for the recipe.
        Steps:
          allOf:
          - $ref: '#/components/schemas/RecipeStepList'
          - description: A list of steps that are defined by the recipe.
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagMap'
          - description: Metadata tags that have been applied to the recipe.
        RecipeVersion:
          allOf:
          - $ref: '#/components/schemas/RecipeVersion'
          - description: <p>The identifier for the version for the recipe. Must be one of the following:</p> <ul> <li> <p>Numeric version (<code>X.Y</code>) - <code>X</code> and <code>Y</code> stand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. Both <code>X</code> and <code>Y</code> are required, and "0.0" isn't a valid version.</p> </li> <li> <p> <code>LATEST_WORKING</code> - the most recent valid version being developed in a DataBrew project.</p> </li> <li> <p> <code>LATEST_PUBLISHED</code> - the most recent published version.</p> </li> </ul>
      description: Represents one or more actions to be performed on a DataBrew dataset.
    ValidationException: {}
    Operation:
      type: string
      pattern: ^[A-Z\_]+$
      minLength: 1
      maxLength: 128
    Condition:
      type: string
      pattern: ^[A-Z\_]+$
      minLength: 1
      maxLength: 128
    ListRecipeVersionsResponse:
      type: object
      required:
      - Recipes
      properties:
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: A token that you can use in a subsequent call to retrieve the next set of results.
        Recipes:
          allOf:
          - $ref: '#/components/schemas/RecipeList'
          - description: A list of versions for the specified recipe.
    RecipeVersion:
      type: string
      minLength: 1
      maxLength: 16
    RecipeList:
      type: array
      items:
        $ref: '#/components/schemas/Recipe'
    PublishedBy:
      type: string
    ConditionExpression:
      type: object
      required:
      - Condition
      - TargetColumn
      properties:
        Condition:
          allOf:
          - $ref: '#/components/schemas/Condition'
          - description: A specific condition to apply to a recipe action. For more information, see <a href="https://docs.aws.amazon.com/databrew/latest/dg/recipes.html#recipes.structure">Recipe structure</a> in the <i>Glue DataBrew Developer Guide</i>.
        Value:
          allOf:
          - $ref: '#/components/schemas/ConditionValue'
          - description: A value that the condition must evaluate to for the condition to succeed.
        TargetColumn:
          allOf:
          - $ref: '#/components/schemas/TargetColumn'
          - description: A column to apply this condition to.
      description: <p>Represents an individual condition that evaluates to true or false.</p> <p>Conditions are used with recipe actions. The action is only performed for column values where the condition evaluates to true.</p> <p>If a recipe requires more than one condition, then the recipe must specify multiple <code>ConditionExpression</code> elements. Each condition is applied to the rows in a dataset first, before the recipe action is performed.</p>
    ConditionValue:
      type: string
      maxLength: 1024
    ConditionExpressionList:
      type: array
      items:
        $ref: '#/components/schemas/ConditionExpression'
    TargetColumn:
      type: string
      minLength: 1
      maxLength: 1024
  parameters:
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      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-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      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-Algorithm:
      name: X-Amz-Algorithm
      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