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

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.GetDatabases 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.GetDatabases API across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-getdatabases-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-getdatabases-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.GetDatabases API'
paths:
  /#X-Amz-Target=AWSGlue.GetDatabases:
    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: GetDatabases
      description: Retrieves all databases defined in a given Data Catalog.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDatabasesResponse'
              examples:
                GetDatabases200Example:
                  summary: Default GetDatabases 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                GetDatabases480Example:
                  summary: Default GetDatabases 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                GetDatabases481Example:
                  summary: Default GetDatabases 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                GetDatabases482Example:
                  summary: Default GetDatabases 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '483':
          description: GlueEncryptionException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlueEncryptionException'
              examples:
                GetDatabases483Example:
                  summary: Default GetDatabases 483 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDatabasesRequest'
      parameters:
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.GetDatabases
      summary: Amazon Glue Get Databases
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.GetDatabases 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)
  /#GetDatabases:
    post:
      operationId: post#GetDatabases
      summary: Get Databases
      description: Retrieves all databases defined in a given Data Catalog.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetDatabasesResponse_2'
        '400':
          description: EntityNotFoundException; FederationSourceException; FederationSourceRetryableException; GlueEncryptionException; InvalidInputException; OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EntityNotFoundException'
        '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.GetDatabases
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetDatabasesRequest_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.GetDatabases API'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: GetDatabases
    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: {}
    CatalogGetterPageSize:
      type: integer
      minimum: 1
      maximum: 100
    FederationIdentifier:
      type: string
      minLength: 1
      maxLength: 512
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    ParametersMapValue:
      type: string
      maxLength: 512000
    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
    Database:
      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: These key-value pairs define parameters and properties of the database.
        CreateTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time at which the metadata database was created in the catalog.
        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.
        CatalogId:
          allOf:
          - $ref: '#/components/schemas/CatalogIdString'
          - description: The ID of the Data Catalog in which the database resides.
        FederatedDatabase:
          allOf:
          - $ref: '#/components/schemas/FederatedDatabase'
          - description: A <code>FederatedDatabase</code> structure that references an entity outside the Glue Data Catalog.
      description: The <code>Database</code> object represents a logical grouping of tables that might reside in a Hive metastore or an RDBMS.
    Permission:
      type: string
      enum:
      - ALL
      - SELECT
      - ALTER
      - DROP
      - DELETE
      - INSERT
      - CREATE_DATABASE
      - CREATE_TABLE
      - DATA_LOCATION_ACCESS
    GetDatabasesResponse:
      type: object
      required:
      - DatabaseList
      properties:
        DatabaseList:
          allOf:
          - $ref: '#/components/schemas/DatabaseList'
          - description: A list of <code>Database</code> objects from the specified catalog.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/Token'
          - description: A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
    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.
    Token:
      type: string
    Timestamp:
      type: string
      format: date-time
    GetDatabasesRequest:
      type: object
      title: GetDatabasesRequest
      properties:
        CatalogId:
          allOf:
          - $ref: '#/components/schemas/CatalogIdString'
          - description: The ID of the Data Catalog from which to retrieve <code>Databases</code>. If none is provided, the Amazon Web Services account ID is used by default.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/Token'
          - description: A continuation token, if this is a continuation call.
        MaxResults:
          allOf:
          - $ref: '#/components/schemas/CatalogGetterPageSize'
          - description: The maximum number of databases to return in one response.
        ResourceShareType:
          allOf:
          - $ref: '#/components/schemas/ResourceShareType'
          - description: <p>Allows you to specify that you want to list the databases shared with your account. The allowable values are <code>FEDERATED</code>, <code>FOREIGN</code> or <code>ALL</code>. </p> <ul> <li> <p>If set to <code>FEDERATED</code>, will list the federated databases (referencing an external entity) shared with your account.</p> </li> <li> <p>If set to <code>FOREIGN</code>, will list the databases shared with your account. </p> </li> <li> <p>If set to <code>ALL</code>, will list the databases shared with your account, as well as the databases in yor local account. </p> </li> </ul>
    ResourceShareType:
      type: string
      enum:
      - FOREIGN
      - ALL
      - FEDERATED
    PrincipalPermissionsList:
      type: array
      items:
        $ref: '#/components/schemas/PrincipalPermissions'
    InternalServiceException: {}
    DatabaseList:
      type: array
      items:
        $ref: '#/components/schemas/Database'
    OperationTimeoutException: {}
    GetDatabasesRequest_2:
      type: object
      properties:
        CatalogId:
          type: string
          description: The ID of the Data Catalog from which to retrieve Databases. If none is provided, the Amazon Web Services account ID is used by default.
        NextToken:
          type: string
          description: A continuation token, if this is a continuation call.
        MaxResults:
          type: integer
          description: The maximum number of databases to return in one response.
        ResourceShareType:
          type: string
          enum:
          - FOREIGN
          - ALL
          - FEDERATED
          description: Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL. If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account. If set to FOREIGN, will list the databases shared with your account. If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.
        AttributesToGet:
          type: array
          items:
            type: string
            enum:
            - NAME
            - TARGET_DATABASE
          description: Specifies the database fields returned by the GetDatabases call. This parameter doesn’t accept an empty list. The request must include the 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.
    Database_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.
        CreateTime:
          type: string
          format: date-time
          description: The time at which the metadata database was created in the catalog.
        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'
        CatalogId:
          type: string
          description: The ID of the Data Catalog in which the database resides.
        FederatedDatabase:
          $ref: '#/components/schemas/FederatedDatabase_2'
      required:
      - Name
    InternalServiceException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    GetDatabasesResponse_2:
      type: object
      properties:
        DatabaseList:
          type: array
          items:
            $ref: '#/components/schemas/Database_2'
          description: A list of Database objects from the specified catalog.
        NextToken:
          type: string
          description: A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
      required:
      - DatabaseList
    EntityNotFoundException:
      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.
    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-getdatabases-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-getdatabases-api-api-openapi.yml
x-hasEquivalentPaths: true