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

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.UpdateWorkflow 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.UpdateWorkflow API across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-updateworkflow-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-updateworkflow-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.UpdateWorkflow API'
paths:
  /#X-Amz-Target=AWSGlue.UpdateWorkflow:
    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: UpdateWorkflow
      description: Updates an existing workflow.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkflowResponse'
              examples:
                UpdateWorkflow200Example:
                  summary: Default UpdateWorkflow 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                UpdateWorkflow480Example:
                  summary: Default UpdateWorkflow 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: EntityNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotFoundException'
              examples:
                UpdateWorkflow481Example:
                  summary: Default UpdateWorkflow 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                UpdateWorkflow482Example:
                  summary: Default UpdateWorkflow 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '483':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                UpdateWorkflow483Example:
                  summary: Default UpdateWorkflow 483 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '484':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
              examples:
                UpdateWorkflow484Example:
                  summary: Default UpdateWorkflow 484 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkflowRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.UpdateWorkflow
      summary: Amazon Glue Update Workflow
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.UpdateWorkflow 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)
  /#UpdateWorkflow:
    post:
      operationId: post#UpdateWorkflow
      summary: Update Workflow
      description: Updates an existing workflow.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateWorkflowResponse_2'
        '400':
          description: ConcurrentModificationException; EntityNotFoundException; InvalidInputException; OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException_2'
        '500':
          description: InternalServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceException_2'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.UpdateWorkflow
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateWorkflowRequest_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.UpdateWorkflow API'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: UpdateWorkflow
    servers:
    - url: https://glue.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    NameString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    InvalidInputException: {}
    EntityNotFoundException: {}
    UpdateWorkflowRequest:
      type: object
      required:
      - Name
      title: UpdateWorkflowRequest
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: Name of the workflow to be updated.
        Description:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The description of the workflow.
        DefaultRunProperties:
          allOf:
          - $ref: '#/components/schemas/WorkflowRunProperties'
          - description: A collection of properties to be used as part of each execution of the workflow.
        MaxConcurrentRuns:
          allOf:
          - $ref: '#/components/schemas/NullableInteger'
          - description: You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
    NullableInteger:
      type: integer
    OperationTimeoutException: {}
    InternalServiceException: {}
    WorkflowRunProperties:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/GenericString'
    ConcurrentModificationException: {}
    UpdateWorkflowResponse:
      type: object
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the workflow which was specified in input.
    GenericString:
      type: string
    ConcurrentModificationException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    UpdateWorkflowResponse_2:
      type: object
      properties:
        Name:
          type: string
          description: The name of the workflow which was specified in input.
    InternalServiceException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    UpdateWorkflowRequest_2:
      type: object
      properties:
        Name:
          type: string
          description: Name of the workflow to be updated.
        Description:
          type: string
          description: The description of the workflow.
        DefaultRunProperties:
          type: object
          additionalProperties:
            type: string
          description: A collection of properties to be used as part of each execution of the workflow. Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
        MaxConcurrentRuns:
          type: integer
          description: You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
      required:
      - Name
  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-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-Security-Token:
      name: X-Amz-Security-Token
      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-updateworkflow-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-updateworkflow-api-api-openapi.yml
x-hasEquivalentPaths: true