AWS Glue AWS Glue #X Amz Target=AWSGlue.GetPlan API

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.GetPlan API'
  version: '2017-03-31'
  x-refined-note:
  - x-apiClientRegistration differs across the merged source definitions and was not carried
  - x-apisguru-categories differs across the merged source definitions and was not carried
  - x-logo differs across the merged source definitions and was not carried
  - x-origin differs across the merged source definitions and was not carried
  - x-preferred differs across the merged source definitions and was not carried
  - x-providerName differs across the merged source definitions and was not carried
  - x-release differs across the merged source definitions and was not carried
  - x-serviceName differs across the merged source definitions and was not carried
  description: 'Operations tagged AWS Glue #X Amz Target=AWSGlue.GetPlan API across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-getplan-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-getplan-api-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://glue.{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 multi-region endpoint
- url: https://glue.{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 multi-region endpoint
- url: http://glue.{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 endpoint for China (Beijing) and China (Ningxia)
- url: https://glue.{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 endpoint for China (Beijing) and China (Ningxia)
tags:
- name: 'AWS Glue #X Amz Target=AWSGlue.GetPlan API'
paths:
  /#X-Amz-Target=AWSGlue.GetPlan:
    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: GetPlan
      description: Gets code to perform a specified mapping.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlanResponse'
              examples:
                GetPlan200Example:
                  summary: Default GetPlan 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                GetPlan480Example:
                  summary: Default GetPlan 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                GetPlan481Example:
                  summary: Default GetPlan 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                GetPlan482Example:
                  summary: Default GetPlan 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPlanRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.GetPlan
      summary: Amazon Glue Get Plan
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.GetPlan API'
      security:
      - hmac: []
    servers:
    - url: http://glue.{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 multi-region endpoint
    - url: https://glue.{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 multi-region endpoint
    - url: http://glue.{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 endpoint for China (Beijing) and China (Ningxia)
    - url: https://glue.{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 endpoint for China (Beijing) and China (Ningxia)
  /#GetPlan:
    post:
      operationId: post#GetPlan
      summary: Get Plan
      description: Gets code to perform a specified mapping.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetPlanResponse_2'
        '500':
          description: InternalServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceException_2'
        '400':
          description: InvalidInputException; OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException_2'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.GetPlan
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetPlanRequest_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.GetPlan API'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: GetPlan
    servers:
    - url: https://glue.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    InvalidInputException: {}
    NameString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    Boolean:
      type: boolean
    GetPlanResponse:
      type: object
      properties:
        PythonScript:
          allOf:
          - $ref: '#/components/schemas/PythonScript'
          - description: A Python script to perform the mapping.
        ScalaCode:
          allOf:
          - $ref: '#/components/schemas/ScalaCode'
          - description: The Scala code to perform the mapping.
    CodeGenNodeArg:
      type: object
      required:
      - Name
      - Value
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/CodeGenArgName'
          - description: The name of the argument or property.
        Value:
          allOf:
          - $ref: '#/components/schemas/CodeGenArgValue'
          - description: The value of the argument or property.
        Param:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: True if the value is used as a parameter.
      description: An argument or property of a node.
    CodeGenArgValue:
      type: string
    FieldType:
      type: string
    PythonScript:
      type: string
    MappingList:
      type: array
      items:
        $ref: '#/components/schemas/MappingEntry'
    GetPlanRequest:
      type: object
      required:
      - Mapping
      - Source
      title: GetPlanRequest
      properties:
        Mapping:
          allOf:
          - $ref: '#/components/schemas/MappingList'
          - description: The list of mappings from a source table to target tables.
        Source:
          allOf:
          - $ref: '#/components/schemas/CatalogEntry'
          - description: The source table.
        Sinks:
          allOf:
          - $ref: '#/components/schemas/CatalogEntries'
          - description: The target tables.
        Location:
          allOf:
          - $ref: '#/components/schemas/Location'
          - description: The parameters for the mapping.
        Language:
          allOf:
          - $ref: '#/components/schemas/Language'
          - description: The programming language of the code to perform the mapping.
        AdditionalPlanOptionsMap:
          allOf:
          - $ref: '#/components/schemas/AdditionalPlanOptionsMap'
          - description: <p>A map to hold additional optional key-value parameters.</p> <p>Currently, these key-value pairs are supported:</p> <ul> <li> <p> <code>inferSchema</code>  —  Specifies whether to set <code>inferSchema</code> to true or false for the default script generated by an Glue job. For example, to set <code>inferSchema</code> to true, pass the following key value pair:</p> <p> <code>--additional-plan-options-map '{"inferSchema":"true"}'</code> </p> </li> </ul>
    CatalogEntries:
      type: array
      items:
        $ref: '#/components/schemas/CatalogEntry'
    SchemaPathString:
      type: string
    CatalogEntry:
      type: object
      required:
      - DatabaseName
      - TableName
      properties:
        DatabaseName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The database in which the table metadata resides.
        TableName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the table in question.
      description: Specifies a table definition in the Glue Data Catalog.
    Location:
      type: object
      properties:
        Jdbc:
          allOf:
          - $ref: '#/components/schemas/CodeGenNodeArgs'
          - description: A JDBC location.
        S3:
          allOf:
          - $ref: '#/components/schemas/CodeGenNodeArgs'
          - description: An Amazon Simple Storage Service (Amazon S3) location.
        DynamoDB:
          allOf:
          - $ref: '#/components/schemas/CodeGenNodeArgs'
          - description: An Amazon DynamoDB table location.
      description: The location of resources.
    CodeGenArgName:
      type: string
    GenericString:
      type: string
    ScalaCode:
      type: string
    MappingEntry:
      type: object
      properties:
        SourceTable:
          allOf:
          - $ref: '#/components/schemas/TableName'
          - description: The name of the source table.
        SourcePath:
          allOf:
          - $ref: '#/components/schemas/SchemaPathString'
          - description: The source path.
        SourceType:
          allOf:
          - $ref: '#/components/schemas/FieldType'
          - description: The source type.
        TargetTable:
          allOf:
          - $ref: '#/components/schemas/TableName'
          - description: The target table.
        TargetPath:
          allOf:
          - $ref: '#/components/schemas/SchemaPathString'
          - description: The target path.
        TargetType:
          allOf:
          - $ref: '#/components/schemas/FieldType'
          - description: The target type.
      description: Defines a mapping.
    CodeGenNodeArgs:
      type: array
      items:
        $ref: '#/components/schemas/CodeGenNodeArg'
      minItems: 0
      maxItems: 50
    TableName:
      type: string
    InternalServiceException: {}
    Language:
      type: string
      enum:
      - PYTHON
      - SCALA
    OperationTimeoutException: {}
    AdditionalPlanOptionsMap:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/GenericString'
    GetPlanRequest_2:
      type: object
      properties:
        Mapping:
          type: array
          items:
            $ref: '#/components/schemas/MappingEntry_2'
          description: The list of mappings from a source table to target tables.
        Source:
          $ref: '#/components/schemas/CatalogEntry_2'
        Sinks:
          type: array
          items:
            $ref: '#/components/schemas/CatalogEntry_2'
          description: The target tables.
        Location:
          $ref: '#/components/schemas/Location_2'
        Language:
          type: string
          enum:
          - PYTHON
          - SCALA
          description: The programming language of the code to perform the mapping.
        AdditionalPlanOptionsMap:
          type: object
          additionalProperties:
            type: string
          description: 'A map to hold additional optional key-value parameters. Currently, these key-value pairs are supported: inferSchema — Specifies whether to set inferSchema to true or false for the default script generated by an Glue job. For example, to set inferSchema to true, pass the following key value pair: --additional-plan-options-map ''{"inferSchema":"true"}'''
      required:
      - Mapping
      - Source
    InvalidInputException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
        FromFederationSource:
          type: boolean
          description: Indicates whether or not the exception relates to a federated source.
    MappingEntry_2:
      type: object
      properties:
        SourceTable:
          type: string
          description: The name of the source table.
        SourcePath:
          type: string
          description: The source path.
        SourceType:
          type: string
          description: The source type.
        TargetTable:
          type: string
          description: The target table.
        TargetPath:
          type: string
          description: The target path.
        TargetType:
          type: string
          description: The target type.
    CatalogEntry_2:
      type: object
      properties:
        DatabaseName:
          type: string
          description: The database in which the table metadata resides.
        TableName:
          type: string
          description: The name of the table in question.
      required:
      - DatabaseName
      - TableName
    CodeGenNodeArg_2:
      type: object
      properties:
        Name:
          type: string
          description: The name of the argument or property.
        Value:
          type: string
          description: The value of the argument or property.
        Param:
          type: boolean
          description: True if the value is used as a parameter.
      required:
      - Name
      - Value
    GetPlanResponse_2:
      type: object
      properties:
        PythonScript:
          type: string
          description: A Python script to perform the mapping.
        ScalaCode:
          type: string
          description: The Scala code to perform the mapping.
    InternalServiceException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    Location_2:
      type: object
      properties:
        Jdbc:
          type: array
          items:
            $ref: '#/components/schemas/CodeGenNodeArg_2'
          description: A JDBC location.
        S3:
          type: array
          items:
            $ref: '#/components/schemas/CodeGenNodeArg_2'
          description: An Amazon Simple Storage Service (Amazon S3) location.
        DynamoDB:
          type: array
          items:
            $ref: '#/components/schemas/CodeGenNodeArg_2'
          description: An Amazon DynamoDB table location.
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      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
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      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-SignedHeaders:
      name: X-Amz-SignedHeaders
      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
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: glue
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/glue/
x-refined-from:
- amazon-glue-x-amz-target-awsglue-getplan-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-getplan-api-api-openapi.yml
x-hasEquivalentPaths: true