AWS Glue AWS Glue #X Amz Target=AWSGlue.UpdateJobFromSourceControl… API

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.UpdateJobFromSourceControl……'
  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.UpdateJobFromSourceControl… across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-updatejobfromsourcecontrol-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-updatejobfromsourcecontrol-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.UpdateJobFromSourceControl…'
paths:
  /#X-Amz-Target=AWSGlue.UpdateJobFromSourceControl:
    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: UpdateJobFromSourceControl
      description: 'Synchronizes a job from the source control repository. This operation takes the job artifacts that are located in the remote repository and updates the Glue internal stores with these artifacts.


        This API supports optional parameters which take in the repository information.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateJobFromSourceControlResponse'
              examples:
                UpdateJobFromSourceControl200Example:
                  summary: Default UpdateJobFromSourceControl 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                UpdateJobFromSourceControl480Example:
                  summary: Default UpdateJobFromSourceControl 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: AlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlreadyExistsException'
              examples:
                UpdateJobFromSourceControl481Example:
                  summary: Default UpdateJobFromSourceControl 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                UpdateJobFromSourceControl482Example:
                  summary: Default UpdateJobFromSourceControl 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '483':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                UpdateJobFromSourceControl483Example:
                  summary: Default UpdateJobFromSourceControl 483 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '484':
          description: EntityNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotFoundException'
              examples:
                UpdateJobFromSourceControl484Example:
                  summary: Default UpdateJobFromSourceControl 484 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '485':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                UpdateJobFromSourceControl485Example:
                  summary: Default UpdateJobFromSourceControl 485 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '486':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                UpdateJobFromSourceControl486Example:
                  summary: Default UpdateJobFromSourceControl 486 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateJobFromSourceControlRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.UpdateJobFromSourceControl
      summary: Amazon Glue Update Job from Source Control
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.UpdateJobFromSourceControl…'
      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)
  /#UpdateJobFromSourceControl:
    post:
      operationId: post#UpdateJobFromSourceControl
      summary: Update Job From Source Control
      description: Synchronizes a job from the source control repository. This operation takes the job artifacts that are located in the remote repository and updates the Glue internal stores with these artifacts. This API supports optional parameters which take in the repository information.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateJobFromSourceControlResponse_2'
        '400':
          description: AccessDeniedException; AlreadyExistsException; EntityNotFoundException; InvalidInputException; OperationTimeoutException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException_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.UpdateJobFromSourceControl
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateJobFromSourceControlRequest_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.UpdateJobFromSourceControl…'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: UpdateJobFromSourceControl
    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: {}
    AuthTokenString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    SourceControlProvider:
      type: string
      enum:
      - GITHUB
      - AWS_CODE_COMMIT
    UpdateJobFromSourceControlResponse:
      type: object
      properties:
        JobName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the Glue job.
    EntityNotFoundException: {}
    ValidationException: {}
    CommitIdString:
      type: string
      minLength: 1
      maxLength: 40
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    SourceControlAuthStrategy:
      type: string
      enum:
      - PERSONAL_ACCESS_TOKEN
      - AWS_SECRETS_MANAGER
    AlreadyExistsException: {}
    UpdateJobFromSourceControlRequest:
      type: object
      title: UpdateJobFromSourceControlRequest
      properties:
        JobName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the Glue job to be synchronized to or from the remote repository.
        Provider:
          allOf:
          - $ref: '#/components/schemas/SourceControlProvider'
          - description: The provider for the remote repository.
        RepositoryName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the remote repository that contains the job artifacts.
        RepositoryOwner:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The owner of the remote repository that contains the job artifacts.
        BranchName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: An optional branch in the remote repository.
        Folder:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: An optional folder in the remote repository.
        CommitId:
          allOf:
          - $ref: '#/components/schemas/CommitIdString'
          - description: A commit ID for a commit in the remote repository.
        AuthStrategy:
          allOf:
          - $ref: '#/components/schemas/SourceControlAuthStrategy'
          - description: The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
        AuthToken:
          allOf:
          - $ref: '#/components/schemas/AuthTokenString'
          - description: The value of the authorization token.
    AccessDeniedException: {}
    InternalServiceException: {}
    OperationTimeoutException: {}
    UpdateJobFromSourceControlRequest_2:
      type: object
      properties:
        JobName:
          type: string
          description: The name of the Glue job to be synchronized to or from the remote repository.
        Provider:
          type: string
          enum:
          - GITHUB
          - GITLAB
          - BITBUCKET
          - AWS_CODE_COMMIT
          description: 'The provider for the remote repository. Possible values: GITHUB, AWS_CODE_COMMIT, GITLAB, BITBUCKET.'
        RepositoryName:
          type: string
          description: The name of the remote repository that contains the job artifacts. For BitBucket providers, RepositoryName should include WorkspaceName. Use the format /.
        RepositoryOwner:
          type: string
          description: The owner of the remote repository that contains the job artifacts.
        BranchName:
          type: string
          description: An optional branch in the remote repository.
        Folder:
          type: string
          description: An optional folder in the remote repository.
        CommitId:
          type: string
          description: A commit ID for a commit in the remote repository.
        AuthStrategy:
          type: string
          enum:
          - PERSONAL_ACCESS_TOKEN
          - AWS_SECRETS_MANAGER
          description: The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
        AuthToken:
          type: string
          description: The value of the authorization token.
    AccessDeniedException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    InternalServiceException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    UpdateJobFromSourceControlResponse_2:
      type: object
      properties:
        JobName:
          type: string
          description: The name of the Glue job.
  parameters:
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      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
    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-updatejobfromsourcecontrol-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-updatejobfromsourcecontrol-api-openapi.yml
x-hasEquivalentPaths: true