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

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.UpdateDatabase 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.UpdateDatabase API across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-updatedatabase-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-updatedatabase-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.UpdateDatabase API'
paths:
  /#X-Amz-Target=AWSGlue.UpdateDatabase:
    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: UpdateDatabase
      description: Updates an existing database definition in a Data Catalog.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDatabaseResponse'
              examples:
                UpdateDatabase200Example:
                  summary: Default UpdateDatabase 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: EntityNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotFoundException'
              examples:
                UpdateDatabase480Example:
                  summary: Default UpdateDatabase 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                UpdateDatabase481Example:
                  summary: Default UpdateDatabase 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                UpdateDatabase482Example:
                  summary: Default UpdateDatabase 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '483':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                UpdateDatabase483Example:
                  summary: Default UpdateDatabase 483 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '484':
          description: GlueEncryptionException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlueEncryptionException'
              examples:
                UpdateDatabase484Example:
                  summary: Default UpdateDatabase 484 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '485':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
              examples:
                UpdateDatabase485Example:
                  summary: Default UpdateDatabase 485 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDatabaseRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.UpdateDatabase
      summary: Amazon Glue Update Database
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.UpdateDatabase 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)
  /#UpdateDatabase:
    post:
      operationId: post#UpdateDatabase
      summary: Update Database
      description: Updates an existing database definition in a Data Catalog.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateDatabaseResponse'
        '400':
          description: AlreadyExistsException; ConcurrentModificationException; EntityNotFoundException; FederationSourceException; FederationSourceRetryableException; GlueEncryptionException; InvalidInputException; OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AlreadyExistsException'
        '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.UpdateDatabase
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateDatabaseRequest_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.UpdateDatabase API'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: UpdateDatabase
    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: {}
    PrincipalPermissions:
      type: object
      properties:
        Principal:
          allOf:
          - $ref: '#/components/schemas/DataLakePrincipal'
          - description: The principal who is granted permissions.
        Permissions:
          allOf:
          - $ref: '#/components/schemas/PermissionList'
          - description: The permissions that are granted to the principal.
      description: Permissions granted to a principal.
    GlueEncryptionException: {}
    UpdateDatabaseRequest:
      type: object
      required:
      - Name
      - DatabaseInput
      title: UpdateDatabaseRequest
      properties:
        CatalogId:
          allOf:
          - $ref: '#/components/schemas/CatalogIdString'
          - description: The ID of the Data Catalog in which the metadata database resides. If none is provided, the Amazon Web Services account ID is used by default.
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.
        DatabaseInput:
          allOf:
          - $ref: '#/components/schemas/DatabaseInput'
          - description: A <code>DatabaseInput</code> object specifying the new definition of the metadata database in the catalog.
    EntityNotFoundException: {}
    FederationIdentifier:
      type: string
      minLength: 1
      maxLength: 512
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    ParametersMapValue:
      type: string
      maxLength: 512000
    DatabaseInput:
      type: object
      required:
      - Name
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
        Description:
          allOf:
          - $ref: '#/components/schemas/DescriptionString'
          - description: A description of the database.
        LocationUri:
          allOf:
          - $ref: '#/components/schemas/URI'
          - description: 'The location of the database (for example, an HDFS path). '
        Parameters:
          allOf:
          - $ref: '#/components/schemas/ParametersMap'
          - description: <p>These key-value pairs define parameters and properties of the database.</p> <p>These key-value pairs define parameters and properties of the database.</p>
        CreateTableDefaultPermissions:
          allOf:
          - $ref: '#/components/schemas/PrincipalPermissionsList'
          - description: Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
        TargetDatabase:
          allOf:
          - $ref: '#/components/schemas/DatabaseIdentifier'
          - description: A <code>DatabaseIdentifier</code> structure that describes a target database for resource linking.
        FederatedDatabase:
          allOf:
          - $ref: '#/components/schemas/FederatedDatabase'
          - description: A <code>FederatedDatabase</code> structure that references an entity outside the Glue Data Catalog.
      description: The structure used to create or update a database.
    DescriptionString:
      type: string
      minLength: 0
      maxLength: 2048
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    DataLakePrincipalString:
      type: string
      minLength: 1
      maxLength: 255
    Permission:
      type: string
      enum:
      - ALL
      - SELECT
      - ALTER
      - DROP
      - DELETE
      - INSERT
      - CREATE_DATABASE
      - CREATE_TABLE
      - DATA_LOCATION_ACCESS
    PermissionList:
      type: array
      items:
        $ref: '#/components/schemas/Permission'
    ParametersMap:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/ParametersMapValue'
    URI:
      type: string
      minLength: 1
      maxLength: 1024
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    CatalogIdString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    DataLakePrincipal:
      type: object
      properties:
        DataLakePrincipalIdentifier:
          allOf:
          - $ref: '#/components/schemas/DataLakePrincipalString'
          - description: An identifier for the Lake Formation principal.
      description: The Lake Formation principal.
    FederatedDatabase:
      type: object
      properties:
        Identifier:
          allOf:
          - $ref: '#/components/schemas/FederationIdentifier'
          - description: A unique identifier for the federated database.
        ConnectionName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the connection to the external metastore.
      description: A database that points to an entity outside the Glue Data Catalog.
    DatabaseIdentifier:
      type: object
      properties:
        CatalogId:
          allOf:
          - $ref: '#/components/schemas/CatalogIdString'
          - description: The ID of the Data Catalog in which the database resides.
        DatabaseName:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the catalog database.
      description: A structure that describes a target database for resource linking.
    PrincipalPermissionsList:
      type: array
      items:
        $ref: '#/components/schemas/PrincipalPermissions'
    InternalServiceException: {}
    UpdateDatabaseResponse:
      type: object
      properties: {}
    ConcurrentModificationException: {}
    OperationTimeoutException: {}
    DatabaseInput_2:
      type: object
      properties:
        Name:
          type: string
          description: The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
        Description:
          type: string
          description: A description of the database.
        LocationUri:
          type: string
          description: The location of the database (for example, an HDFS path).
        Parameters:
          type: object
          additionalProperties:
            type: string
          description: These key-value pairs define parameters and properties of the database. These key-value pairs define parameters and properties of the database.
        CreateTableDefaultPermissions:
          type: array
          items:
            $ref: '#/components/schemas/PrincipalPermissions_2'
          description: Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
        TargetDatabase:
          $ref: '#/components/schemas/DatabaseIdentifier_2'
        FederatedDatabase:
          $ref: '#/components/schemas/FederatedDatabase_2'
      required:
      - Name
    PrincipalPermissions_2:
      type: object
      properties:
        Principal:
          $ref: '#/components/schemas/DataLakePrincipal_2'
        Permissions:
          type: array
          items:
            type: string
            enum:
            - ALL
            - SELECT
            - ALTER
            - DROP
            - DELETE
            - INSERT
            - CREATE_DATABASE
            - CREATE_TABLE
            - DATA_LOCATION_ACCESS
          description: The permissions that are granted to the principal.
    DataLakePrincipal_2:
      type: object
      properties:
        DataLakePrincipalIdentifier:
          type: string
          description: An identifier for the Lake Formation principal.
    AlreadyExistsException:
      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.
    UpdateDatabaseRequest_2:
      type: object
      properties:
        CatalogId:
          type: string
          description: The ID of the Data Catalog in which the metadata database resides. If none is provided, the Amazon Web Services account ID is used by default.
        Name:
          type: string
          description: The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.
        DatabaseInput:
          $ref: '#/components/schemas/DatabaseInput_2'
      required:
      - Name
      - DatabaseInput
    FederatedDatabase_2:
      type: object
      properties:
        Identifier:
          type: string
          description: A unique identifier for the federated database.
        ConnectionName:
          type: string
          description: The name of the connection to the external metastore.
        ConnectionType:
          type: string
          description: The type of connection used to access the federated database, such as JDBC, ODBC, or other supported connection protocols.
    DatabaseIdentifier_2:
      type: object
      properties:
        CatalogId:
          type: string
          description: The ID of the Data Catalog in which the database resides.
        DatabaseName:
          type: string
          description: The name of the catalog database.
        Region:
          type: string
          description: Region of the target database.
  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-updatedatabase-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-updatedatabase-api-api-openapi.yml
x-hasEquivalentPaths: true